Skip to content

Commit 7f241cf

Browse files
committed
Add dependencies in vignette
1 parent 8ee2ef2 commit 7f241cf

4 files changed

Lines changed: 40 additions & 6 deletions

File tree

.DS_Store

0 Bytes
Binary file not shown.

docs/.DS_Store

0 Bytes
Binary file not shown.

docs/vignette.ipynb

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,32 @@
6666
"| `python-dotenv` | Load API key from `.env` |\n",
6767
"| `chess` | Validate Meta-Chess moves and board state |\n",
6868
"| `spacy`, `en_core_web_sm` | Sentence splitting and tokenisation for creativity scoring |\n",
69-
"| `sentence_transformers` | Word embeddings for novelty / surprise |\n",
70-
"| `benepar` | Constituency parsing (optional pipeline extension) |\n",
69+
"| `sentence_transformers` | Word embeddings for novelty / surprise (downloads `thenlper/gte-large` on first use) |\n",
70+
"| `benepar` | Constituency parsing (spaCy pipeline extension used by creativity scoring) |\n",
71+
"| `numpy` | Numerical helpers in scoring |\n",
72+
"| `streamlit` | Web UI (`streamlit_app.py`) |\n",
73+
"| `altair` | Charts in the Streamlit app |\n",
74+
"\n",
75+
"**Optional** (`[project.optional-dependencies]`):\n",
76+
"\n",
77+
"| Package | Role |\n",
78+
"|---|---|\n",
79+
"| `pytest` | Unit tests (`pip install -e \\\".[dev]\\\"`) |\n",
80+
"\n",
81+
"**Vignette / notebook only** (not in `pyproject.toml`; install if you run §3 plotting cells):\n",
82+
"\n",
83+
"| Package | Role |\n",
84+
"|---|---|\n",
85+
"| `matplotlib` | Example figures in this report |\n",
7186
"\n",
7287
"Install from the repository root:\n",
7388
"\n",
7489
"```bash\n",
7590
"python -m venv .venv\n",
7691
"source .venv/bin/activate # Windows: .venv\\Scripts\\activate\n",
77-
"pip install -e \".[dev]\"\n",
92+
"pip install -e \".[dev]\" # package + pytest\n",
93+
"# Optional, for §3 matplotlib examples:\n",
94+
"pip install matplotlib\n",
7895
"```\n",
7996
"\n",
8097
"#### Scenario\n",

docs/vignette.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,32 @@ The primary user is a **computational social-science or NLP researcher** (gradua
5353
| `python-dotenv` | Load API key from `.env` |
5454
| `chess` | Validate Meta-Chess moves and board state |
5555
| `spacy`, `en_core_web_sm` | Sentence splitting and tokenisation for creativity scoring |
56-
| `sentence_transformers` | Word embeddings for novelty / surprise |
57-
| `benepar` | Constituency parsing (optional pipeline extension) |
56+
| `sentence_transformers` | Word embeddings for novelty / surprise (downloads `thenlper/gte-large` on first use) |
57+
| `benepar` | Constituency parsing (spaCy pipeline extension used by creativity scoring) |
58+
| `numpy` | Numerical helpers in scoring |
59+
| `streamlit` | Web UI (`streamlit_app.py`) |
60+
| `altair` | Charts in the Streamlit app |
61+
62+
**Optional** (`[project.optional-dependencies]`):
63+
64+
| Package | Role |
65+
|---|---|
66+
| `pytest` | Unit tests (`pip install -e ".[dev]"`) |
67+
68+
**Vignette / notebook only** (not in `pyproject.toml`; install if you run §3 plotting cells):
69+
70+
| Package | Role |
71+
|---|---|
72+
| `matplotlib` | Example figures in this report |
5873

5974
Install from the repository root:
6075

6176
```bash
6277
python -m venv .venv
6378
source .venv/bin/activate # Windows: .venv\Scripts\activate
64-
pip install -e ".[dev]"
79+
pip install -e ".[dev]" # package + pytest
80+
# Optional, for §3 matplotlib examples:
81+
pip install matplotlib
6582
```
6683

6784
#### Scenario

0 commit comments

Comments
 (0)