Skip to content

Commit 1fa564a

Browse files
committed
better
1 parent ca045d8 commit 1fa564a

File tree

2 files changed

+0
-87
lines changed

2 files changed

+0
-87
lines changed

docs/cli_reference.md

Lines changed: 0 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
Welcome to the llama-stack-client CLI - a command-line interface for interacting with Llama Stack
44

5-
### Usage
6-
75
```
86
Usage: llama-stack-client [OPTIONS] COMMAND [ARGS]...
97
```
@@ -54,8 +52,6 @@ Usage: llama-stack-client [OPTIONS] COMMAND [ARGS]...
5452

5553
Configure Llama Stack Client CLI.
5654

57-
### Usage
58-
5955
```
6056
Usage: llama-stack-client configure [OPTIONS]
6157
```
@@ -74,8 +70,6 @@ Usage: llama-stack-client configure [OPTIONS]
7470

7571
Manage datasets.
7672

77-
### Usage
78-
7973
```
8074
Usage: llama-stack-client datasets [OPTIONS] COMMAND [ARGS]...
8175
```
@@ -96,8 +90,6 @@ Usage: llama-stack-client datasets [OPTIONS] COMMAND [ARGS]...
9690

9791
Show available datasets on distribution endpoint
9892

99-
### Usage
100-
10193
```
10294
Usage: llama-stack-client datasets list [OPTIONS]
10395
```
@@ -112,8 +104,6 @@ Usage: llama-stack-client datasets list [OPTIONS]
112104

113105
Create a new dataset
114106

115-
### Usage
116-
117107
```
118108
Usage: llama-stack-client datasets register [OPTIONS]
119109
```
@@ -142,8 +132,6 @@ Usage: llama-stack-client datasets register [OPTIONS]
142132

143133
Run evaluation tasks.
144134

145-
### Usage
146-
147135
```
148136
Usage: llama-stack-client eval [OPTIONS] COMMAND [ARGS]...
149137
```
@@ -164,8 +152,6 @@ Usage: llama-stack-client eval [OPTIONS] COMMAND [ARGS]...
164152

165153
Run a evaluation benchmark task
166154

167-
### Usage
168-
169155
```
170156
Usage: llama-stack-client eval run-benchmark [OPTIONS] BENCHMARK_IDS...
171157
```
@@ -200,8 +186,6 @@ Usage: llama-stack-client eval run-benchmark [OPTIONS] BENCHMARK_IDS...
200186

201187
Run scoring from application datasets
202188

203-
### Usage
204-
205189
```
206190
Usage: llama-stack-client eval run-scoring [OPTIONS] SCORING_FUNCTION_IDS...
207191
```
@@ -232,8 +216,6 @@ Usage: llama-stack-client eval run-scoring [OPTIONS] SCORING_FUNCTION_IDS...
232216

233217
Manage evaluation tasks.
234218

235-
### Usage
236-
237219
```
238220
Usage: llama-stack-client eval-tasks [OPTIONS] COMMAND [ARGS]...
239221
```
@@ -254,8 +236,6 @@ Usage: llama-stack-client eval-tasks [OPTIONS] COMMAND [ARGS]...
254236

255237
Show available eval tasks on distribution endpoint
256238

257-
### Usage
258-
259239
```
260240
Usage: llama-stack-client eval-tasks list [OPTIONS]
261241
```
@@ -270,8 +250,6 @@ Usage: llama-stack-client eval-tasks list [OPTIONS]
270250

271251
Register a new eval task
272252

273-
### Usage
274-
275253
```
276254
Usage: llama-stack-client eval-tasks register [OPTIONS]
277255
```
@@ -298,8 +276,6 @@ Usage: llama-stack-client eval-tasks register [OPTIONS]
298276

299277
Inference (chat).
300278

301-
### Usage
302-
303279
```
304280
Usage: llama-stack-client inference [OPTIONS] COMMAND [ARGS]...
305281
```
@@ -318,8 +294,6 @@ Usage: llama-stack-client inference [OPTIONS] COMMAND [ARGS]...
318294

319295
Show available inference chat completion endpoints on distribution endpoint
320296

321-
### Usage
322-
323297
```
324298
Usage: llama-stack-client inference chat-completion [OPTIONS]
325299
```
@@ -342,8 +316,6 @@ Usage: llama-stack-client inference chat-completion [OPTIONS]
342316

343317
Inspect server configuration.
344318

345-
### Usage
346-
347319
```
348320
Usage: llama-stack-client inspect [OPTIONS] COMMAND [ARGS]...
349321
```
@@ -362,8 +334,6 @@ Usage: llama-stack-client inspect [OPTIONS] COMMAND [ARGS]...
362334

363335
Show available providers on distribution endpoint
364336

365-
### Usage
366-
367337
```
368338
Usage: llama-stack-client inspect version [OPTIONS]
369339
```
@@ -378,8 +348,6 @@ Usage: llama-stack-client inspect version [OPTIONS]
378348

379349
Manage GenAI models.
380350

381-
### Usage
382-
383351
```
384352
Usage: llama-stack-client models [OPTIONS] COMMAND [ARGS]...
385353
```
@@ -404,8 +372,6 @@ Usage: llama-stack-client models [OPTIONS] COMMAND [ARGS]...
404372

405373
Show available llama models at distribution endpoint
406374

407-
### Usage
408-
409375
```
410376
Usage: llama-stack-client models get [OPTIONS] MODEL_ID
411377
```
@@ -424,8 +390,6 @@ Usage: llama-stack-client models get [OPTIONS] MODEL_ID
424390

425391
Show available llama models at distribution endpoint
426392

427-
### Usage
428-
429393
```
430394
Usage: llama-stack-client models list [OPTIONS]
431395
```
@@ -440,8 +404,6 @@ Usage: llama-stack-client models list [OPTIONS]
440404

441405
Register a new model at distribution endpoint
442406

443-
### Usage
444-
445407
```
446408
Usage: llama-stack-client models register [OPTIONS] MODEL_ID
447409
```
@@ -466,8 +428,6 @@ Usage: llama-stack-client models register [OPTIONS] MODEL_ID
466428

467429
Unregister a model from distribution endpoint
468430

469-
### Usage
470-
471431
```
472432
Usage: llama-stack-client models unregister [OPTIONS] MODEL_ID
473433
```
@@ -486,8 +446,6 @@ Usage: llama-stack-client models unregister [OPTIONS] MODEL_ID
486446

487447
Post-training.
488448

489-
### Usage
490-
491449
```
492450
Usage: llama-stack-client post-training [OPTIONS] COMMAND [ARGS]...
493451
```
@@ -514,8 +472,6 @@ Usage: llama-stack-client post-training [OPTIONS] COMMAND [ARGS]...
514472

515473
Get the training artifacts of a specific post training job
516474

517-
### Usage
518-
519475
```
520476
Usage: llama-stack-client post-training artifacts [OPTIONS]
521477
```
@@ -532,8 +488,6 @@ Usage: llama-stack-client post-training artifacts [OPTIONS]
532488

533489
Cancel the training job
534490

535-
### Usage
536-
537491
```
538492
Usage: llama-stack-client post-training cancel [OPTIONS]
539493
```
@@ -550,8 +504,6 @@ Usage: llama-stack-client post-training cancel [OPTIONS]
550504

551505
Show the list of available post training jobs
552506

553-
### Usage
554-
555507
```
556508
Usage: llama-stack-client post-training list [OPTIONS]
557509
```
@@ -566,8 +518,6 @@ Usage: llama-stack-client post-training list [OPTIONS]
566518

567519
Show the status of a specific post training job
568520

569-
### Usage
570-
571521
```
572522
Usage: llama-stack-client post-training status [OPTIONS]
573523
```
@@ -584,8 +534,6 @@ Usage: llama-stack-client post-training status [OPTIONS]
584534

585535
Kick off a supervised fine tune job
586536

587-
### Usage
588-
589537
```
590538
Usage: llama-stack-client post-training supervised_fine_tune
591539
[OPTIONS]
@@ -611,8 +559,6 @@ Usage: llama-stack-client post-training supervised_fine_tune
611559

612560
Manage API providers.
613561

614-
### Usage
615-
616562
```
617563
Usage: llama-stack-client providers [OPTIONS] COMMAND [ARGS]...
618564
```
@@ -631,8 +577,6 @@ Usage: llama-stack-client providers [OPTIONS] COMMAND [ARGS]...
631577

632578
Show available providers on distribution endpoint
633579

634-
### Usage
635-
636580
```
637581
Usage: llama-stack-client providers list [OPTIONS]
638582
```
@@ -647,8 +591,6 @@ Usage: llama-stack-client providers list [OPTIONS]
647591

648592
Manage scoring functions.
649593

650-
### Usage
651-
652594
```
653595
Usage: llama-stack-client scoring-functions [OPTIONS] COMMAND [ARGS]...
654596
```
@@ -669,8 +611,6 @@ Usage: llama-stack-client scoring-functions [OPTIONS] COMMAND [ARGS]...
669611

670612
Show available scoring functions on distribution endpoint
671613

672-
### Usage
673-
674614
```
675615
Usage: llama-stack-client scoring-functions list [OPTIONS]
676616
```
@@ -685,8 +625,6 @@ Usage: llama-stack-client scoring-functions list [OPTIONS]
685625

686626
Register a new scoring function
687627

688-
### Usage
689-
690628
```
691629
Usage: llama-stack-client scoring-functions register [OPTIONS]
692630
```
@@ -713,8 +651,6 @@ Usage: llama-stack-client scoring-functions register [OPTIONS]
713651

714652
Manage safety shield services.
715653

716-
### Usage
717-
718654
```
719655
Usage: llama-stack-client shields [OPTIONS] COMMAND [ARGS]...
720656
```
@@ -735,8 +671,6 @@ Usage: llama-stack-client shields [OPTIONS] COMMAND [ARGS]...
735671

736672
Show available safety shields on distribution endpoint
737673

738-
### Usage
739-
740674
```
741675
Usage: llama-stack-client shields list [OPTIONS]
742676
```
@@ -751,8 +685,6 @@ Usage: llama-stack-client shields list [OPTIONS]
751685

752686
Register a new safety shield
753687

754-
### Usage
755-
756688
```
757689
Usage: llama-stack-client shields register [OPTIONS]
758690
```
@@ -775,8 +707,6 @@ Usage: llama-stack-client shields register [OPTIONS]
775707

776708
Manage available tool groups.
777709

778-
### Usage
779-
780710
```
781711
Usage: llama-stack-client toolgroups [OPTIONS] COMMAND [ARGS]...
782712
```
@@ -801,8 +731,6 @@ Usage: llama-stack-client toolgroups [OPTIONS] COMMAND [ARGS]...
801731

802732
Show available llama toolgroups at distribution endpoint
803733

804-
### Usage
805-
806734
```
807735
Usage: llama-stack-client toolgroups get [OPTIONS] TOOLGROUP_ID
808736
```
@@ -821,8 +749,6 @@ Usage: llama-stack-client toolgroups get [OPTIONS] TOOLGROUP_ID
821749

822750
Show available llama toolgroups at distribution endpoint
823751

824-
### Usage
825-
826752
```
827753
Usage: llama-stack-client toolgroups list [OPTIONS]
828754
```
@@ -837,8 +763,6 @@ Usage: llama-stack-client toolgroups list [OPTIONS]
837763

838764
Register a new toolgroup at distribution endpoint
839765

840-
### Usage
841-
842766
```
843767
Usage: llama-stack-client toolgroups register [OPTIONS] TOOLGROUP_ID
844768
```
@@ -865,8 +789,6 @@ Usage: llama-stack-client toolgroups register [OPTIONS] TOOLGROUP_ID
865789

866790
Unregister a toolgroup from distribution endpoint
867791

868-
### Usage
869-
870792
```
871793
Usage: llama-stack-client toolgroups unregister [OPTIONS] TOOLGROUP_ID
872794
```
@@ -885,8 +807,6 @@ Usage: llama-stack-client toolgroups unregister [OPTIONS] TOOLGROUP_ID
885807

886808
Manage vector databases.
887809

888-
### Usage
889-
890810
```
891811
Usage: llama-stack-client vector-dbs [OPTIONS] COMMAND [ARGS]...
892812
```
@@ -909,8 +829,6 @@ Usage: llama-stack-client vector-dbs [OPTIONS] COMMAND [ARGS]...
909829

910830
Show available vector dbs on distribution endpoint
911831

912-
### Usage
913-
914832
```
915833
Usage: llama-stack-client vector-dbs list [OPTIONS]
916834
```
@@ -925,8 +843,6 @@ Usage: llama-stack-client vector-dbs list [OPTIONS]
925843

926844
Create a new vector db
927845

928-
### Usage
929-
930846
```
931847
Usage: llama-stack-client vector-dbs register [OPTIONS] VECTOR_DB_ID
932848
```
@@ -953,8 +869,6 @@ Usage: llama-stack-client vector-dbs register [OPTIONS] VECTOR_DB_ID
953869

954870
Delete a vector db
955871

956-
### Usage
957-
958872
```
959873
Usage: llama-stack-client vector-dbs unregister [OPTIONS] VECTOR_DB_ID
960874
```

scripts/gen_cli_doc.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ def generate_markdown_docs(command, parent=None, level=1):
2727
doc.append(f"{command.help}\n")
2828

2929
# Add usage
30-
doc.append("### Usage\n")
3130
doc.append(f"```\n{command.get_usage(ctx)}\n```\n")
3231

3332
# Add options if present

0 commit comments

Comments
 (0)