doc: update readme

This commit is contained in:
Sergey Penkovsky
2025-07-23 14:45:39 +03:00
parent e0813fedc6
commit 6ce048d4ad

View File

@@ -7,19 +7,40 @@
---
## 🚀 Установка
## Установка
Рекомендуется использовать виртуальное окружение (venv) для изоляции зависимостей и корректной работы импортов.
### Через pip (локально)
```bash
python3 -m venv venv
source venv/bin/activate
pip install .
```
### Через pip (с PyPI)
Также вы можете вручную установить необходимые зависимости:
```bash
pip install torch numpy dill
```
Если появится файл `requirements.txt`, используйте:
```bash
pip install -r requirements.txt
```
Если вы хотите использовать последнюю версию из PyPI:
```bash
pip install simple-llm
```
После установки вы сможете запускать примеры и использовать модули из любого места.
Если возникают ошибки с импортами, убедитесь, что пакет установлен через pip и вы находитесь в активированном виртуальном окружении.
### Основные зависимости
- torch
- numpy
- dill
**Краткая инструкция по обучению на своих данных:**
1. Обучите BPE-токенизатор на тексте (см. `simple_llm.tokenizer.bpe.BPE`).