badjware
/
the-algorithm
mirror of https://github.com/twitter/the-algorithm.git
1
0
Fork 0
Code Releases Activity

README updates 

- renames pushservice readme.md to README.md
- Minor changes to main README.md
This commit is contained in:
twitter-team 2023-05-19 14:36:39 -07:00
parent b389c3d302
commit fb54d8b549
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,6 +1,6 @@
# Twitter's Recommendation Algorithm # Twitter's Recommendation Algorithm
Twitter's Recommendation Algorithm is a set of services and jobs that are responsible for serving feeds of Tweets and other content across all Twitter product surfaces (e.g. For You Timeline, Search, Explore). For an introduction to how the algorithm works, please refer to our [engineering blog](https://blog.twitter.com/engineering/en_us/topics/open-source/2023/twitter-recommendation-algorithm). Twitter's Recommendation Algorithm is a set of services and jobs that are responsible for serving feeds of Tweets and other content across all Twitter product surfaces (e.g. For You Timeline, Search, Explore, Notifications). For an introduction to how the algorithm works, please refer to our [engineering blog](https://blog.twitter.com/engineering/en_us/topics/open-source/2023/twitter-recommendation-algorithm).
## Architecture ## Architecture
@ -8,7 +8,8 @@ Product surfaces at Twitter are built on a shared set of data, models, and softw
| Type | Component | Description | | Type | Component | Description |
|------------|------------|------------| |------------|------------|------------|
| Data | [unified-user-actions](unified_user_actions/README.md) | Real-time stream of user actions on Twitter. | | Data | [tweetypie](tweetypie/server/README.md) | Core Tweet service that handles the reading and writing of Tweet data. |
| | [unified-user-actions](unified_user_actions/README.md) | Real-time stream of user actions on Twitter. |
| | [user-signal-service](user-signal-service/README.md) | Centralized platform to retrieve explicit (e.g. likes, replies) and implicit (e.g. profile visits, tweet clicks) user signals. | | | [user-signal-service](user-signal-service/README.md) | Centralized platform to retrieve explicit (e.g. likes, replies) and implicit (e.g. profile visits, tweet clicks) user signals. |
| Model | [SimClusters](src/scala/com/twitter/simclusters_v2/README.md) | Community detection and sparse embeddings into those communities. | | Model | [SimClusters](src/scala/com/twitter/simclusters_v2/README.md) | Community detection and sparse embeddings into those communities. |
| | [TwHIN](https://github.com/twitter/the-algorithm-ml/blob/main/projects/twhin/README.md) | Dense knowledge graph embeddings for Users and Tweets. | | | [TwHIN](https://github.com/twitter/the-algorithm-ml/blob/main/projects/twhin/README.md) | Dense knowledge graph embeddings for Users and Tweets. |
@ -24,9 +25,8 @@ Product surfaces at Twitter are built on a shared set of data, models, and softw
| | [timelines-aggregation-framework](timelines/data_processing/ml_util/aggregation_framework/README.md) | Framework for generating aggregate features in batch or real time. | | | [timelines-aggregation-framework](timelines/data_processing/ml_util/aggregation_framework/README.md) | Framework for generating aggregate features in batch or real time. |
| | [representation-manager](representation-manager/README.md) | Service to retrieve embeddings (i.e. SimClusers and TwHIN). | | | [representation-manager](representation-manager/README.md) | Service to retrieve embeddings (i.e. SimClusers and TwHIN). |
| | [twml](twml/README.md) | Legacy machine learning framework built on TensorFlow v1. | | | [twml](twml/README.md) | Legacy machine learning framework built on TensorFlow v1. |
| | [Tweetypie](tweetypie/server/README.md) | Core Tweet service that handles the reading and writing of Tweet data. |
The product surface currently included in this repository is the For You Timeline. The product surfaces currently included in this repository are the For You Timeline and Recommended Notifications.
### For You Timeline ### For You Timeline
@ -50,7 +50,7 @@ The core components of the For You Timeline included in this repository are list
### Recommended Notifications ### Recommended Notifications
The core components that power Recommended Notifications included in this repository are listed below: The core components of Recommended Notifications included in this repository are listed below:
| Type | Component | Description | | Type | Component | Description |
|------------|------------|------------| |------------|------------|------------|

6
pushservice/readme.md → pushservice/README.md
View File

@ -17,9 +17,9 @@ RefreshForPushHandler follows these steps:
- Fetch Candidates - Fetch Candidates
- Retrieves a list of potential candidates for the push by querying various candidate sources using the target - Retrieves a list of potential candidates for the push by querying various candidate sources using the target
- Candidate Hydration - Candidate Hydration
- Hydrates the candidate details with batch calls to different downstream services. - Hydrates the candidate details with batch calls to different downstream services
- Pre-rank Filtering, also called Light Filtering - Pre-rank Filtering, also called Light Filtering
- Filters the hydrated candidates with lightweight RPC calls. - Filters the hydrated candidates with lightweight RPC calls
- Rank - Rank
- Perform feature hydration for candidates and target user - Perform feature hydration for candidates and target user
- Performs light ranking on candidates - Performs light ranking on candidates
@ -36,7 +36,7 @@ SendHandler follows these steps:
- Building Target - Building Target
- Builds a target user object based on the given user ID - Builds a target user object based on the given user ID
- Candidate Hydration - Candidate Hydration
- Hydrates the candidate details with batch calls to different downstream services. - Hydrates the candidate details with batch calls to different downstream services
- Feature Hydration - Feature Hydration
- Perform feature hydration for candidates and target user - Perform feature hydration for candidates and target user
- Take Step, also called Heavy Filtering - Take Step, also called Heavy Filtering