From c4e21dfc156a64f51d32f27ba4acdfc1affed31c Mon Sep 17 00:00:00 2001 From: Faeez Shaikh Date: Sat, 1 Apr 2023 17:14:02 -0500 Subject: [PATCH] Improving README Formatting and Clarity for Increased Accessibility --- README.md | 38 +++++++++++++++++++++++++++++++++++--- 1 file changed, 35 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6a03955..3965a83 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ +# Twitter Machine Learning models + This project open sources some of the ML models used at Twitter. +## Models Currently these are: 1. The "For You" Heavy Ranker (projects/home/recap). @@ -7,8 +10,37 @@ Currently these are: 2. TwHIN embeddings (projects/twhin) https://arxiv.org/abs/2202.05387 -This project can be run inside a python virtualenv. We have only tried this on Linux machines and because we use torchrec it works best with an Nvidia GPU. To setup run +## Installation + +To install this project, follow these steps: + +1. Clone the repository to your local machine. +2. Navigate to the project directory. +3. Run the following command to set up a Python virtual environment: + + `./images/init_venv.sh` (Linux only). + +Note: This command is only supported on Linux machines. + +4. Follow the instructions provided in the READMEs of each project to run the desired model. + +### Note: +This project can be run inside a python virtualenv. We have only tried this on Linux machines and because we use `torchrec` it works best with an Nvidia GPU. + + + +## Contributing + +To contribute to this project, please follow these steps: + +1. Submit a bug report or feature request via the issue tracker. +2. Fork the repository and make your changes on a new branch. +3. Submit a pull request with your changes. + +## License + +This project is licensed under the [insert license here]. Copyright (c) [insert copyright information]. -`./images/init_venv.sh` (Linux only). +## Resources -The READMEs of each project contain instructions about how to run each project. +- https://developer.twitter.com/en/docs \ No newline at end of file