Skip to content

Commit f68667e

Browse files
committed
updated readme
1 parent 71934fb commit f68667e

File tree

6 files changed

+19
-79
lines changed

6 files changed

+19
-79
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,23 @@ StructEval is a framework for evaluating language models on structured outputs,
88

99
```bash
1010
# Create and activate the conda environment from the environment.yml file
11-
conda env create -f environment.yml
11+
conda create -n structeval python=3.12
1212
conda activate structeval
1313

14-
# Install the package in development mode
15-
pip install -e .
14+
# Install all required packages(required)
15+
pip install -r requirements.txt
16+
17+
# Separately install the llm-engines(required for inference)
18+
pip install git+https://github.com/jdf-prog/LLM-Engines.git
1619

17-
# Install playwright browsers (required for web rendering)
20+
# Install playwright browsers (required for rendering)
1821
playwright install
22+
23+
# You could also install the package in development mode(optional)
24+
pip install -e .
1925
```
2026

21-
### System Dependencies
27+
### System Dependencies(Optional to read)
2228

2329
The following system packages will be installed automatically through conda:
2430
- `ghostscript` and `poppler`: Required for PDF processing

condaenv.fjxcvgg1.requirements.txt

Lines changed: 0 additions & 15 deletions
This file was deleted.

condaenv.pkh1vnp8.requirements.txt

Lines changed: 0 additions & 12 deletions
This file was deleted.

environment-basic.yml

Lines changed: 0 additions & 23 deletions
This file was deleted.

environment-minimal.yml

Lines changed: 0 additions & 23 deletions
This file was deleted.

setup.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,18 @@
1313
entry_points={"console_scripts": ["structeval = structeval.cli:main"]},
1414
install_requires=[
1515
"fire",
16+
"llm-engines",
17+
"playwright",
1618
"transformers",
1719
"sentencepiece",
1820
"torch",
1921
"accelerate",
20-
"llm-engines"
22+
"xmltodict",
23+
"toml",
24+
"pdf2image",
25+
"dotenv",
26+
"markdown",
27+
"matplotlib"
2128
],
2229
extras_require={}
2330
)

0 commit comments

Comments
 (0)