Merge pull request #5 from HaroldLeo/fix-local-notebook-setup

Improve local notebook setup instructions

Author: sanbuphy

README-CN.md

@@ -136,10 +136,32 @@ Modern LLM Notebook 选择中间路线：把现代 LLM 当成一个可以拆解
 ```bash
 git clone https://github.com/walkinglabs/modern-llm-notebook.git
 cd modern-llm-notebook
-pip install -r requirements.txt
+
+# 创建独立 Python 环境，避免把依赖直接装进系统 Python。
+python3 -m venv .venv
+source .venv/bin/activate
+
+python -m pip install --upgrade pip
+python -m pip install -r requirements.txt
+python -m ipykernel install --user \
+  --name modern-llm-notebook \
+  --display-name "Python (modern-llm-notebook)"
+
 jupyter notebook notebooks/part1-foundation/01-tokenizer-basics.ipynb
 ```
 
+如果出现 `jupyter: command not found`，通常是因为还没有激活虚拟环境。先运行：
+
+```bash
+source .venv/bin/activate
+```
+
+也可以直接调用虚拟环境里的 Jupyter：
+
+```bash
+.venv/bin/jupyter notebook notebooks/part1-foundation/01-tokenizer-basics.ipynb
+```
+
 语言说明：
 
 - 中文版 Notebook：`notebooks/`

README.md

@@ -166,10 +166,32 @@ comparison or utility work, but the teaching path keeps the core algorithms expl
 ```bash
 git clone https://github.com/walkinglabs/modern-llm-notebook.git
 cd modern-llm-notebook
-pip install -r requirements.txt
+
+# Create an isolated Python environment instead of installing into the system Python.
+python3 -m venv .venv
+source .venv/bin/activate
+
+python -m pip install --upgrade pip
+python -m pip install -r requirements.txt
+python -m ipykernel install --user \
+  --name modern-llm-notebook \
+  --display-name "Python (modern-llm-notebook)"
+
 jupyter notebook notebooks-en/part1-foundation/01-tokenizer-basics.ipynb
 ```
 
+If `jupyter: command not found` appears, the virtual environment is probably not active. Run:
+
+```bash
+source .venv/bin/activate
+```
+
+Or call Jupyter directly from the environment:
+
+```bash
+.venv/bin/jupyter notebook notebooks-en/part1-foundation/01-tokenizer-basics.ipynb
+```
+
 Language note:
 
 - Chinese notebooks live in `notebooks/`

requirements.txt

@@ -9,3 +9,6 @@ transformers>=4.30.0
 datasets>=2.12.0
 accelerate>=0.20.0
 modelscope>=1.9.0
+tiktoken>=0.5.0
+jupyter>=1.0.0
+ipykernel>=6.0.0