Commit 123217a1 authored by Juraj Mikuš's avatar Juraj Mikuš
Browse files

readme complete installation guide

parent 3fb5ebe3
Loading
Loading
Loading
Loading
+27 −3
Original line number Diff line number Diff line
@@ -41,10 +41,34 @@ Python 3.10+
LangChain — framework na orchestráciu LLM agentov
e-infra LLM API — LLM modely

## Spustenie
## Inštalácia a spustenie
Projekt je možné spustiť vo virtuálnom prostredí venv, pre ktoré je pripravený requirements.txt.
Ďalej je potrebné už iba nastavenie premennej prostredia "EINFRA_API_TOKEN". (vlastný api kľúč pre einfra LLM api).
Projekt sa spúšťa spustením main.py.
Pre spustenie je potrebný E-INFRA api token. Návod na získanie je popísaný tu: https://nlp.fi.muni.cz/en/UsingGPUeInfra.
Po získaní kľúča je potrebné ho nastaviť ako premennú prostredia "EINFRA_API_TOKEN".
Pre Windows - v CMD: setx EINFRA_API_TOKEN "TVOJ_TOKEN".
Pre Linux - do ~/.bashrc pridať: export EINFRA_API_TOKEN="TVOJ_TOKEN", následne source ~/.bashrc.

### Klonovamie repozitára
git clone https://gitlab.fi.muni.cz/xmikus3/python-helper/
cd python_helper

Alebo manuálne stiahnuť .zip a rozbaliť zložku.

### Vytvorenie a aktivácia virtuálneho prostredia venv
Windows: 
python -m venv venv
venv\Scripts\activate

Linux:
python3 -m venv venv
source venv/bin/activate

### Inštalácia závislostí
pip install -r requirements.txt

### Spustenie 
Po aktivácii virtuálneho prostredia:
python main.py

## Príklady použitia
Vysvetlenie funkcie: