From 6ce048d4adf0aedadb938abb43f15b3f9b5726a9 Mon Sep 17 00:00:00 2001 From: Sergey Penkovsky Date: Wed, 23 Jul 2025 14:45:39 +0300 Subject: [PATCH] doc: update readme --- README.md | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 092f20d..2e7081d 100644 --- a/README.md +++ b/README.md @@ -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`).