Skip to content

Commit b0544d8

Browse files
docs(data-designer-retrieval-sdg): use NVIDIA-NeMo plugin index in README install steps (#47)
The plugin is distributed from the NVIDIA-NeMo plugin index on GitHub Pages, not PyPI. The README still showed a bare `pip install data-designer-retrieval-sdg` instruction, which 404s. Replace the Installation section with three install variants, all layering the NVIDIA-NeMo index alongside PyPI so transitive dependencies (data-designer, nltk, pyarrow, pyyaml) still resolve from PyPI: - `uv pip install` for one-shot installs - `uv add` for projects managed by uv - `pip install` with `--index-url` / `--extra-index-url` for pip users Also drop the stray "single PyPI package" / "the same pip install" phrasings in the Plugins section. Verified end-to-end in a fresh venv: install resolves `data-designer-retrieval-sdg==0.1.0` from the NVIDIA-NeMo index, the CLI binary works, and both `embedding-dedup` and `document-chunker` entry points pass `assert_valid_plugin()`. Signed-off-by: Steve Han <sthan@nvidia.com> Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 9910bfe commit b0544d8

1 file changed

Lines changed: 35 additions & 5 deletions

File tree

plugins/data-designer-retrieval-sdg/README.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ finetuning.
99

1010
## Plugins
1111

12-
The single PyPI package contributes two plugins to DataDesigner's
13-
registries via `[project.entry-points."data_designer.plugins"]`:
12+
A single package contributes two plugins to DataDesigner's registries
13+
via `[project.entry-points."data_designer.plugins"]`:
1414

1515
| Slug | Type | Purpose |
1616
|------|------|---------|
1717
| `embedding-dedup` | column generator | Generic cosine-similarity dedup of any list-valued column. Implements native `agenerate()` for the async engine. |
1818
| `document-chunker` | seed reader | Sentence-chunks a directory of text files and emits structured sections, with optional multi-document bundling. |
1919

20-
Both ship with the same `pip install data-designer-retrieval-sdg` and
21-
become discoverable automatically through Python entry points.
20+
Both are registered automatically through Python entry points when the
21+
package is installed (see [Installation](#installation)).
2222

2323
## Native async (`DATA_DESIGNER_ASYNC_ENGINE=1`)
2424

@@ -36,10 +36,40 @@ runs on Python 3.10+ via the framework's sync bridge.
3636

3737
## Installation
3838

39+
The package is distributed from the NVIDIA-NeMo plugin index (hosted on
40+
GitHub Pages); it is not on PyPI. Install it by adding the plugin index
41+
alongside PyPI:
42+
43+
```bash
44+
uv pip install \
45+
--default-index https://pypi.org/simple/ \
46+
--index https://nvidia-nemo.github.io/DataDesignerPlugins/simple/ \
47+
data-designer-retrieval-sdg
48+
```
49+
50+
For projects managed with `uv`, add it as a dependency:
51+
3952
```bash
40-
pip install data-designer-retrieval-sdg
53+
uv add \
54+
--default-index https://pypi.org/simple/ \
55+
--index https://nvidia-nemo.github.io/DataDesignerPlugins/simple/ \
56+
data-designer-retrieval-sdg
4157
```
4258

59+
`pip` users can pass the equivalent flags:
60+
61+
```bash
62+
pip install \
63+
--index-url https://pypi.org/simple/ \
64+
--extra-index-url https://nvidia-nemo.github.io/DataDesignerPlugins/simple/ \
65+
data-designer-retrieval-sdg
66+
```
67+
68+
Standard version constraints work (`>=0.1`, `==0.1.0`, ...). The
69+
NVIDIA-NeMo index only serves `data-designer-*` plugin packages; the
70+
default PyPI index supplies transitive dependencies (`data-designer`,
71+
`nltk`, `pyarrow`, `pyyaml`).
72+
4373
For development inside the monorepo:
4474

4575
```bash

0 commit comments

Comments
 (0)