Skip to content

Commit fb54d8b

Browse files
author
twitter-team
committed
README updates
- renames pushservice readme.md to README.md - Minor changes to main README.md
1 parent b389c3d commit fb54d8b

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# Twitter's Recommendation Algorithm
22

3-
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).
3+
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).
44

55
## Architecture
66

77
Product surfaces at Twitter are built on a shared set of data, models, and software frameworks. The shared components included in this repository are listed below:
88

99
| Type | Component | Description |
1010
|------------|------------|------------|
11-
| Data | [unified-user-actions](unified_user_actions/README.md) | Real-time stream of user actions on Twitter. |
11+
| Data | [tweetypie](tweetypie/server/README.md) | Core Tweet service that handles the reading and writing of Tweet data. |
12+
| | [unified-user-actions](unified_user_actions/README.md) | Real-time stream of user actions on Twitter. |
1213
| | [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. |
1314
| Model | [SimClusters](src/scala/com/twitter/simclusters_v2/README.md) | Community detection and sparse embeddings into those communities. |
1415
| | [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
2425
| | [timelines-aggregation-framework](timelines/data_processing/ml_util/aggregation_framework/README.md) | Framework for generating aggregate features in batch or real time. |
2526
| | [representation-manager](representation-manager/README.md) | Service to retrieve embeddings (i.e. SimClusers and TwHIN). |
2627
| | [twml](twml/README.md) | Legacy machine learning framework built on TensorFlow v1. |
27-
| | [Tweetypie](tweetypie/server/README.md) | Core Tweet service that handles the reading and writing of Tweet data. |
2828

29-
The product surface currently included in this repository is the For You Timeline.
29+
The product surfaces currently included in this repository are the For You Timeline and Recommended Notifications.
3030

3131
### For You Timeline
3232

@@ -50,7 +50,7 @@ The core components of the For You Timeline included in this repository are list
5050

5151
### Recommended Notifications
5252

53-
The core components that power Recommended Notifications included in this repository are listed below:
53+
The core components of Recommended Notifications included in this repository are listed below:
5454

5555
| Type | Component | Description |
5656
|------------|------------|------------|

pushservice/readme.md pushservice/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ RefreshForPushHandler follows these steps:
1717
- Fetch Candidates
1818
- Retrieves a list of potential candidates for the push by querying various candidate sources using the target
1919
- Candidate Hydration
20-
- Hydrates the candidate details with batch calls to different downstream services.
20+
- Hydrates the candidate details with batch calls to different downstream services
2121
- Pre-rank Filtering, also called Light Filtering
22-
- Filters the hydrated candidates with lightweight RPC calls.
22+
- Filters the hydrated candidates with lightweight RPC calls
2323
- Rank
2424
- Perform feature hydration for candidates and target user
2525
- Performs light ranking on candidates
@@ -36,7 +36,7 @@ SendHandler follows these steps:
3636
- Building Target
3737
- Builds a target user object based on the given user ID
3838
- Candidate Hydration
39-
- Hydrates the candidate details with batch calls to different downstream services.
39+
- Hydrates the candidate details with batch calls to different downstream services
4040
- Feature Hydration
4141
- Perform feature hydration for candidates and target user
4242
- Take Step, also called Heavy Filtering

0 commit comments

Comments
 (0)