Skip to content

Commit f3d3dbc

Browse files
committed
docs: Update docs
1 parent ac0ed07 commit f3d3dbc

File tree

5 files changed

+65
-24
lines changed

5 files changed

+65
-24
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ celerybeat.pid
123123

124124
# Environments
125125
.env
126+
.env.old
126127
.venv
127128
env/
128129
venv/

INSTALL_AND_USAGE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ You can also run each component separately:
6868
make feature-engineering
6969
```
7070

71+
Go to Hopsworks
72+
7173
2. **Train Retrieval Model**
7274
Execute the retrieval model training Notebook (`notebooks/2_tp_training_retrieval_model.ipynb`):
7375
```bash

README.md

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,44 @@
1212

1313
## What will you learn?
1414

15-
The **Hands-on H&M Real-Time Personalized Recommender”** is a free course that will teach you how to build and deploy a real-time personalized recommender for H&M fashion articles using the 4-stage recommender architecture, the two-tower model design and the Hopsworks AI Lakehouse.
15+
The goal of this course is to teach you how to build and deploy a real-time personalized recommender for H&M fashion articles, going through:
1616

17-
📙 **You will learn:**
18-
19-
- building a recommender using the 4-stage recommender architecture
20-
- training a two-tower model for generating users and item embeddings
21-
- designing a scalable ML system using the FTI architecture
22-
- using MLOps best practices such as a feature store and model registry
23-
- deploying the real-time personalized recommender
24-
- enhancing recommendations with LLMs
25-
- implementing an interactive web interface
17+
- 4-stage recommender architecture
18+
- Two-tower model training
19+
- Scalable ML system design
20+
- MLOps best practices
21+
- Real-time deployment
22+
- LLM-enhanced recommendations
23+
- Interactive web interface
2624

2725
## Who is this for?
2826

27+
ML/AI engineers looking to understand how to design, build and deploy real-time personalized recommenders. Also, it is a good fit for DE/DS/SWE who want to understand the engineering behind a recommender.
28+
29+
This is NOT a course for data scientists or researchers showing how to train the most accurate models. This course will focus mostly on engineering and end-to-end system using MLOps best practices.
30+
2931
## Costs?
3032

33+
The lessons are completely free. Also, we will stick to the free version of all the tools used throughout the course.
34+
35+
The only thing that will cost you ~$1-2 is running the latest lesson on building recommenders with LLMs where we will use the OpenAI API.
36+
37+
To conclude, Lesson 1,2,3, and 4 are free and Lesson 5 will cost you ~$1-2, which you can choose not to run.
38+
3139
## How will you learn?
3240

33-
## Questions and troubleshooting
41+
This is a self-paced course where we provide 5 lessons, which will go over the theory, system design and implementation of building a real-time personalized recommender. Everything is backed by the open-source code found in this repository.
42+
43+
## Lessons
44+
45+
| Lesson | Title | Description | Local Notebooks | Colab Notebooks |
46+
|--------|-------|-------------|----------------|-----------------|
47+
| 1 | [Building a TikTok-like recommender](https://decodingml.substack.com/p/33d3273e-b8e3-4d98-b160-c3d239343022) | Learn how to architect a recommender system using the 4-stage architecture and two-tower model. | - | - |
48+
| 2 | The feature pipeline | Learn how to build a scalable feature pipeline (WIP) | [![Open In Jupyter](https://img.shields.io/badge/Jupyter-Open%20Notebook-blue?logo=Jupyter)](notebooks/1_fp_computing_features.ipynb) | - |
49+
| 3 | The training pipeline | Learn how to train and evaluate recommendation models (WIP) | [2_tp_training_retrieval_model.ipynb](notebooks/2_tp_training_retrieval_model.ipynb), [3_tp_training_ranking_model.ipynb](notebooks/3_tp_training_ranking_model.ipynb) | - |
50+
| 4 | The inference pipeline | Learn how to deploy models for real-time inference (WIP) | [4_ip_computing_item_embeddings.ipynb](notebooks/4_ip_computing_item_embeddings.ipynb), [5_ip_creating_deployments.ipynb](notebooks/5_ip_creating_deployments.ipynb), [6_scheduling_materialization_jobs.ipynb](notebooks/6_scheduling_materialization_jobs.ipynb) | - |
51+
| 5 | Building personalized real-time recommenders with LLMs | Learn how to enhance recommendations with LLMs (WIP) | - | - |
52+
3453

3554
## Project structure
3655

@@ -50,27 +69,19 @@ At Decoding ML we teach how to build production ML systems, thus the course foll
5069
├── pyproject.toml # Project dependencies
5170
```
5271

53-
## Lessons
54-
55-
| Lesson | Title | Description | Local Notebooks | Colab Notebooks |
56-
|--------|-------|-------------|----------------|-----------------|
57-
| 1 | [Building a TikTok-like recommender](https://decodingml.substack.com/p/33d3273e-b8e3-4d98-b160-c3d239343022) | Learn how to architect a recommender system using the 4-stage architecture and two-tower model. | - | - |
58-
| 2 | The feature pipeline | Learn how to build a scalable feature pipeline (WIP) | [1_fp_computing_features.ipynb](notebooks/1_fp_computing_features.ipynb) | - |
59-
| 3 | The training pipeline | Learn how to train and evaluate recommendation models (WIP) | [2_tp_training_retrieval_model.ipynb](notebooks/2_tp_training_retrieval_model.ipynb), [3_tp_training_ranking_model.ipynb](notebooks/3_tp_training_ranking_model.ipynb) | - |
60-
| 4 | The inference pipeline | Learn how to deploy models for real-time inference (WIP) | [4_ip_computing_item_embeddings.ipynb](notebooks/4_ip_computing_item_embeddings.ipynb), [5_ip_creating_deployments.ipynb](notebooks/5_ip_creating_deployments.ipynb), [6_scheduling_materialization_jobs.ipynb](notebooks/6_scheduling_materialization_jobs.ipynb) | - |
61-
| 5 | Building personalized real-time recommenders with LLMs | Learn how to enhance recommendations with LLMs (WIP) | - | - |
62-
63-
6472
## Install and usage
6573

6674
To understand how to install and run the code, go to the [INSTALL_AND_USAGE](https://github.com/decodingml/hands-on-personalized-recommender/blob/main/INSTALL_AND_USAGE.md) dedicated document.
6775

6876
> [!Note]
6977
> Even though you can run everything solely using the INSTALL_AND_USAGE dedicated document, we recommend that you read the articles to understand how the personalized recommender works fully.
7078
79+
## Sponsors
80+
81+
82+
7183
## License
7284

7385
This course is an open-source project released under the Apache-2.0 license. Thus, as long you distribute our LICENSE and acknowledge your project is based on our work, you can safely clone or fork this project and use it as a source of inspiration for your educational projects (e.g., university, college degree, personal projects, etc.).
7486

75-
## Sponsors
76-
87+
## Questions and troubleshooting

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ dependencies = [
1313
"langchain-openai==0.1.14",
1414
"langchain==0.2.6",
1515
"loguru>=0.7.2",
16+
"nbformat>=5.10.4",
1617
"polars==1.9.0",
1718
"pydantic-settings>=2.6.1",
1819
"sentence-transformers==2.2.2",

uv.lock

Lines changed: 26 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)