mirror of
https://github.com/twitter/the-algorithm-ml.git
synced 2024-12-23 06:41:49 +01:00
Improving README Formatting and Clarity for Increased Accessibility
This commit is contained in:
parent
78c3235eee
commit
c4e21dfc15
36
README.md
36
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).
|
||||
|
||||
The READMEs of each project contain instructions about how to run each project.
|
||||
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].
|
||||
|
||||
## Resources
|
||||
|
||||
- https://developer.twitter.com/en/docs
|
Loading…
Reference in New Issue
Block a user