Skip to content

Commit 7bb82ea

Browse files
committed
Replacing command args with command flags
Signed-off-by: Daniele Martinoli <[email protected]>
1 parent 76bb2dc commit 7bb82ea

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

docs/rag/ilab-rag-retrieval.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,12 @@ The proposal is to add a `process` sub-command to the `data` command group.
8181

8282
For the Taxonomy path (no Model Training):
8383
```
84-
ilab data process /path/to/processed/folder
84+
ilab data process --output /path/to/processed/folder
8585
```
8686

8787
For the Plag-and-Play RAG path:
8888
```
89-
ilab data process --input /path/to/docs/folder /path/to/processed/folder
89+
ilab data process --input /path/to/docs/folder --output /path/to/processed/folder
9090
```
9191

9292
#### Command Purpose
@@ -112,18 +112,24 @@ The generated artifacts can later be used to generate and ingest the embeddings
112112
### 2.3 Document Processing Pipeline Options
113113
```bash
114114
% ilab data process --help
115-
Usage: ilab data process [OPTIONS] OUTPUT_DIR
115+
Usage: ilab data process [OPTIONS]
116116

117117
The document processing pipeline
118118

119119
Options:
120-
--input DIRECTORY The folder with user documents to process.
121-
--help Show this message and exit.```
120+
--input DIRECTORY The folder with user documents to process. In case
121+
it's missing, the knowledge taxonomy files will be
122+
processed instead.
123+
--taxonomy-path PATH Directory where taxonomy is stored and accessed from.
124+
--taxonomy-base TEXT Branch of taxonomy used to calculate diff against.
125+
--output DIRECTORY Directory where processed docs are stored.
126+
--help Show this message and exit.
122127
```
123128
124129
| Option Description | Default Value | CLI Flag | Environment Variable |
125130
|--------------------|---------------|----------|----------------------|
126131
| Location folder of user documents. In case it's missing, the taxonomy is navigated to look for updated knowledge documents.| | `--input` | `ILAB_PROCESS_INPUT` |
132+
| Location folder of processed documents. | | `--ouput` | `ILAB_PROCESS_OUTPUT` |
127133
| Base directories where models are stored. | `$HOME/.cache/instructlab/models` | `--model-dir` | `ILAB_MODEL_DIR` |
128134
| Name of the embedding model. | **TBD** | `--embedding-model` | `ILAB_EMBEDDING_MODEL_NAME` |
129135

@@ -137,7 +143,7 @@ ilab data ingest
137143

138144
For the Taxonomy or Plug-and-Play RAG paths:
139145
```
140-
ilab data ingest /path/to/processed/folder
146+
ilab data ingest --input path/to/processed/folder
141147
```
142148

143149
#### Working Assumption
@@ -170,20 +176,24 @@ context for RAG-based chat pipelines.
170176
### 2.5 Embedding Ingestion Pipeline Options
171177
```bash
172178
% ilab data ingest --help
173-
Usage: ilab data ingest [OPTIONS] INPUT_DIR
179+
Usage: ilab data ingest [OPTIONS]
174180
175181
The embedding ingestion pipeline
176182
177183
Options:
178184
--document-store-type TEXT The document store type, one of:
179-
`milvuslite`, `milvus`.
185+
`milvuslite`.
180186
--document-store-uri TEXT The document store URI
181187
--document-store-collection-name TEXT
182188
The document store collection name
183189
--model-dir TEXT Base directories where models are stored.
184190
[default: (The default system model location
185191
store, located in the data directory.)]
186192
--embedding-model TEXT The embedding model name
193+
--output-dir TEXT Directory where generated datasets are
194+
stored.
195+
--input DIRECTORY Directory where pre-processed documents are
196+
located.
187197
--help Show this message and exit.
188198
```
189199

@@ -352,7 +362,7 @@ ilab serve --rag-embeddings --image-name=docker.io/user/my_rag_artifacts:1.0 --p
352362
ilab model chat --rag --retriever-type api --retriever-uri http://localhost:8123
353363
```
354364
355-
[shareable-excalidraw]: https://excalidraw.com/#json=p126_RwjtILDahmnIFK9c,11xoIhRQCkUVRm0Wkg-Ysg
365+
[shareable-excalidraw]: https://excalidraw.com/#json=ZiTMvxn67gep679hqJrpO,VBDADxrmGht7zJSWKQCjug
356366
[ilab-knowledge]: https://github.com/instructlab/taxonomy?tab=readme-ov-file#getting-started-with-knowledge-contributions
357367
[sdg-diff-strategy]: https://github.com/instructlab/sdg/blob/main/src/instructlab/sdg/utils/taxonomy.py
358368
[chat_template]: https://github.com/instructlab/instructlab/blob/0a773f05f8f57285930df101575241c649f591ce/src/instructlab/configuration.py#L244

0 commit comments

Comments
 (0)