Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improving README Formatting and Clarity for Increased Accessibility #104

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improving README Formatting and Clarity for Increased Accessibility #104

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 35 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,46 @@
# 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).

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