Skip to content

Commit c5aa668

Browse files
committed
Update CONTRIBUTING.md to include instructions for local development of hyper-models and modify README.md for demo link. Remove hyper-models workspace configuration from pyproject.toml.
1 parent 04212aa commit c5aa668

3 files changed

Lines changed: 35 additions & 11 deletions

File tree

CONTRIBUTING.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ Clone the repo and install dependencies:
1414

1515
```bash
1616
git clone https://github.com/Hyper3Labs/HyperView.git
17-
git clone https://github.com/Hyper3Labs/hyper-models
1817
cd HyperView
1918

2019
# Create virtual environment and install dev dependencies
@@ -28,6 +27,32 @@ npm install
2827
cd ..
2928
```
3029

30+
### Optional: Co-develop `hyper-models` locally (uv workspace)
31+
32+
By default, HyperView installs `hyper-models` from PyPI.
33+
34+
If you want to develop HyperView and `hyper-models` side-by-side (without publishing `hyper-models`), you can tell **uv** to use a local checkout instead:
35+
36+
1) Clone `hyper-models` next to the HyperView repo (as a sibling directory):
37+
38+
```bash
39+
cd ..
40+
git clone https://github.com/Hyper3Labs/hyper-models
41+
cd HyperView
42+
```
43+
44+
2) Add the following to HyperView's `pyproject.toml` (keep this change local unless the maintainers decide otherwise):
45+
46+
```toml
47+
[tool.uv.workspace]
48+
members = ["../hyper-models"]
49+
50+
[tool.uv.sources]
51+
hyper-models = { workspace = true }
52+
```
53+
54+
3) Use uv's project commands (`uv run ...`, `uv sync`, etc.) so `tool.uv.sources` is respected.
55+
3156
## Running Locally
3257

3358
For the best development experience, run the backend and frontend in separate terminals.

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
> **Open-source dataset curation + embedding visualization (Euclidean + Poincaré disk)**
44
5-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Hyper3Labs/HyperView)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Hyper3Labs/HyperView) [![Open in HF Spaces](https://huggingface.co/datasets/huggingface/badges/resolve/main/open-in-hf-spaces-sm.svg)](https://huggingface.co/spaces/hyper3labs/HyperView)
66

77
<p align="center">
8-
<a href="https://youtu.be/XLaa8FHSQtc" target="_blank">
8+
<a href="https://huggingface.co/spaces/hyper3labs/HyperView" target="_blank">
99
<img src="https://raw.githubusercontent.com/Hyper3Labs/HyperView/main/assets/screenshot.png" alt="HyperView Screenshot" width="100%">
1010
</a>
1111
<br>
12-
<a href="https://youtu.be/XLaa8FHSQtc" target="_blank">Watch the Demo Video</a>
12+
<a href="https://huggingface.co/spaces/hyper3labs/HyperView" target="_blank">Try the live demo on HuggingFace Spaces</a>
1313
</p>
1414

1515
---
@@ -21,14 +21,19 @@
2121
- **HuggingFace Integration**: Load datasets directly from HuggingFace Hub
2222
- **Fast Embeddings**: Uses EmbedAnything for CLIP-based image embeddings
2323

24+
## Updates
25+
26+
- **01-02-26**[The Geometry of Image Embeddings, Hands-on Coding Workshop](https://www.meetup.com/berlin-computer-vision-group/events/312927919/) (Berlin Computer Vision Group)
27+
- **17-01-26**[The Geometry of Image Embeddings, Hands-on Coding Workshop, Part I](https://www.meetup.com/berlin-computer-vision-group/events/312636174/) (Berlin Computer Vision Group)
28+
2429
## Quick Start
2530

2631
**Docs:** [docs/datasets.md](docs/datasets.md) · [docs/colab.md](docs/colab.md) · [CONTRIBUTING.md](CONTRIBUTING.md) · [TESTS.md](TESTS.md)
2732

2833
### Installation
2934

3035
```bash
31-
pip install hyperview
36+
uv pip install hyperview
3237
```
3338

3439
### Run the Demo

pyproject.toml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,3 @@ ignore = ["E501"]
9898
[tool.pytest.ini_options]
9999
asyncio_mode = "auto"
100100
testpaths = ["tests"]
101-
102-
[tool.uv.workspace]
103-
members = ["../hyper-models"]
104-
105-
[tool.uv.sources]
106-
hyper-models = { workspace = true }

0 commit comments

Comments
 (0)