Skip to content

Commit f820f8d

Browse files
committed
feat(cli): unify explicit launch args and remove hardcoded defaults
1 parent 87bdb63 commit f820f8d

File tree

4 files changed

+280
-106
lines changed

4 files changed

+280
-106
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,5 +76,8 @@ AGENTS.md
7676
.agents/
7777
.specstory/
7878

79+
# Deployment repo (managed as a separate nested git repository)
80+
deploy/
81+
7982
# Generated version file (hatch-vcs)
8083
src/hyperview/_version.py

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ For the best development experience, run the backend and frontend in separate te
6161
Runs the Python API server at `http://127.0.0.1:6262`.
6262

6363
```bash
64-
uv run hyperview demo --samples 200 --no-browser
64+
uv run hyperview --dataset cifar10_demo --hf-dataset uoft-cs/cifar10 --split train --image-key img --label-key label --samples 200 --model openai/clip-vit-base-patch32 --no-browser
6565
```
6666

6767
_Tip: Use `HF_DATASETS_OFFLINE=1` if you have cached datasets and want to work offline._

README.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,41 @@
3737
uv pip install hyperview
3838
```
3939

40-
### Run the Demo
40+
### Run HyperView
4141

4242
```bash
43-
hyperview demo --samples 500
43+
hyperview \
44+
--dataset cifar10_demo \
45+
--hf-dataset uoft-cs/cifar10 \
46+
--split train \
47+
--image-key img \
48+
--label-key label \
49+
--samples 500 \
50+
--model openai/clip-vit-base-patch32 \
51+
--geometry both
4452
```
4553

4654
This will:
47-
1. Load 500 samples from CIFAR-100
48-
2. Compute CLIP embeddings
49-
3. Generate Euclidean and Poincaré visualizations
50-
4. Start the server at **http://127.0.0.1:6262**
55+
1. Use dataset `cifar10_demo`
56+
2. Load up to 500 samples from CIFAR-10
57+
3. Compute CLIP embeddings
58+
4. Generate Euclidean and Poincaré visualizations
59+
5. Start the server at **http://127.0.0.1:6262**
60+
61+
You can also launch with explicit dataset/model/projection args:
62+
63+
```bash
64+
hyperview \
65+
--dataset imagenette_clip \
66+
--hf-dataset fastai/imagenette \
67+
--split train \
68+
--image-key image \
69+
--label-key label \
70+
--samples 1000 \
71+
--model openai/clip-vit-base-patch32 \
72+
--method umap \
73+
--geometry euclidean
74+
```
5175

5276
### Python API
5377

0 commit comments

Comments
 (0)