Skip to content

Commit de351a1

Browse files
committed
Update README
1 parent d433f17 commit de351a1

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,4 +95,28 @@ Options:
9595
--help Show this message and exit.
9696
```
9797

98+
### `create-embeddings`
99+
```text
100+
Usage: embeddings create-embeddings [OPTIONS]
101+
102+
Create embeddings for TIMDEX records.
98103
104+
Options:
105+
--model-uri TEXT HuggingFace model URI (e.g., 'org/model-name')
106+
[required]
107+
--model-path PATH Path where the model will be downloaded to and
108+
loaded from, e.g. '/path/to/model'. [required]
109+
-d, --dataset-location PATH TIMDEX dataset location, e.g.
110+
's3://timdex/dataset', to read records from.
111+
[required]
112+
--run-id TEXT TIMDEX ETL run id. [required]
113+
--run-record-offset INTEGER TIMDEX ETL run record offset to start from,
114+
default = 0. [required]
115+
--record-limit INTEGER Limit number of records after --run-record-
116+
offset, default = None (unlimited). [required]
117+
--strategy TEXT Pre-embedding record transformation strategy to
118+
use. Repeatable. [required]
119+
--output-jsonl TEXT Optionally write embeddings to local JSONLines
120+
file (primarily for testing).
121+
--help Show this message and exit.
122+
```

0 commit comments

Comments
 (0)