Skip to content

Commit cbd8e65

Browse files
kitops-bot[bot]javisperezjavisperez
authored
Update kitops-ts documentation (#1152)
* Update kitops-ts documentation Update kitops-ts documentation to reflect commit 6002c0868372f87a8cf39f0bc5c0ded5777dc223 in repository https://github.com/kitops-ml/kitops-ts Signed-off-by: GitHub <noreply@github.com> * Update types.md Signed-off-by: Javis V. Pérez <javisperez@gmail.com> --------- Signed-off-by: GitHub <noreply@github.com> Signed-off-by: Javis V. Pérez <javisperez@gmail.com> Co-authored-by: javisperez <4766570@users.noreply.github.com> Co-authored-by: Javis V. Pérez <javisperez@gmail.com>
1 parent 9f828b5 commit cbd8e65

2 files changed

Lines changed: 71 additions & 32 deletions

File tree

docs/src/docs/kitops-ts/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ const yaml = buildKitfile({
3232
model: {
3333
name: 'sentiment-classifier',
3434
path: './model/weights.pt',
35-
format: 'pytorch',
35+
framework: 'pytorch',
3636
},
3737
datasets: [
3838
{ name: 'training-set', path: './data/train.csv', license: 'CC-BY-4.0' },

docs/src/docs/kitops-ts/types.md

Lines changed: 70 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -427,31 +427,49 @@ type Package = {
427427
428428
---
429429
430+
### `LayerCommons`
431+
432+
Base interface extended by all Kitfile layer types. Provides the common `path` and `description` fields.
433+
434+
```typescript
435+
interface LayerCommons {
436+
path: string;
437+
description?: string;
438+
}
439+
```
440+
441+
| Property | Type | Description |
442+
|---|---|---|
443+
| `path` | `string` | Path to the artifact file or directory. |
444+
| `description` | `string` | Human-readable description. |
445+
446+
---
447+
430448
### `Model`
431449

432-
Model artifact definition in a Kitfile.
450+
Model artifact definition in a Kitfile. Extends [`LayerCommons`](#layerbase).
433451

434452
```typescript
435-
interface Model {
453+
interface Model extends LayerCommons {
436454
name?: string;
437-
path?: string;
438-
parts?: ModelPart[];
455+
framework?: string;
456+
version?: string;
439457
license?: string;
440-
description?: string;
441-
format?: string;
442-
parameters?: Record<string, string | number>;
458+
parts?: ModelPart[];
459+
parameters?: unknown;
443460
}
444461
```
445462

446463
| Property | Type | Description |
447464
|---|---|---|
465+
| `path` | `string` | Path to the model file or directory. *(from `LayerCommons`)* |
466+
| `description` | `string` | Human-readable description. *(from `LayerCommons`)* |
448467
| `name` | `string` | Display name for the model. |
449-
| `path` | `string` | Path to the model file or directory. |
450-
| `parts` | [`ModelPart[]`](#modelpart) | Sub-parts of a composite model (e.g. split weight files). |
468+
| `framework` | `string` | ML framework (e.g. `'pytorch'`, `'tensorflow'`). |
469+
| `version` | `string` | Model version. |
451470
| `license` | `string` | SPDX license identifier. |
452-
| `description` | `string` | Human-readable description. |
453-
| `format` | `string` | Model format (e.g. `'gguf'`, `'safetensors'`). |
454-
| `parameters` | `Record<string, string \| number>` | Arbitrary model parameters (e.g. context length, quantization). |
471+
| `parts` | [`ModelPart[]`](#modelpart) | Sub-parts of a composite model (e.g. split weight files). |
472+
| `parameters` | `unknown` | Arbitrary model parameters. |
455473

456474
---
457475

@@ -461,67 +479,88 @@ A sub-part of a composite model.
461479

462480
```typescript
463481
interface ModelPart {
482+
name?: string;
464483
path?: string;
465484
type?: string;
466-
license?: string;
467485
}
468486
```
469487

488+
| Property | Type | Description |
489+
|---|---|---|
490+
| `name` | `string` | Display name for this part. |
491+
| `path` | `string` | Path to the part file. |
492+
| `type` | `string` | Part type identifier. |
493+
470494
---
471495

472496
### `Dataset`
473497

474-
Dataset artifact definition in a Kitfile.
498+
Dataset artifact definition in a Kitfile. Extends [`LayerCommons`](#layerbase).
475499

476500
```typescript
477-
interface Dataset {
501+
interface Dataset extends LayerCommons {
478502
name?: string;
479-
path?: string;
480-
description?: string;
481503
license?: string;
482504
parameters?: unknown;
483505
}
484506
```
485507

508+
| Property | Type | Description |
509+
|---|---|---|
510+
| `path` | `string` | Path to the dataset file or directory. *(from `LayerCommons`)* |
511+
| `description` | `string` | Human-readable description. *(from `LayerCommons`)* |
512+
| `name` | `string` | Display name for the dataset. |
513+
| `license` | `string` | SPDX license identifier. |
514+
| `parameters` | `unknown` | Arbitrary dataset parameters. |
515+
486516
---
487517

488518
### `Code`
489519

490-
Source code artifact definition in a Kitfile.
520+
Source code artifact definition in a Kitfile. Extends [`LayerCommons`](#layerbase).
491521

492522
```typescript
493-
interface Code {
494-
path: string;
495-
description: string;
523+
interface Code extends LayerCommons {
524+
license?: string;
496525
}
497526
```
498527

528+
| Property | Type | Description |
529+
|---|---|---|
530+
| `path` | `string` | Path to the source code file or directory. *(from `LayerCommons`)* |
531+
| `description` | `string` | Human-readable description. *(from `LayerCommons`)* |
532+
| `license` | `string` | SPDX license identifier. |
533+
499534
---
500535

501536
### `Doc`
502537

503-
Documentation artifact definition in a Kitfile.
538+
Documentation artifact definition in a Kitfile. Extends [`LayerCommons`](#layerbase).
504539

505540
```typescript
506-
interface Doc {
507-
path: string;
508-
description: string;
509-
}
541+
interface Doc extends LayerCommons {}
510542
```
511543

544+
| Property | Type | Description |
545+
|---|---|---|
546+
| `path` | `string` | Path to the documentation file or directory. *(from `LayerCommons`)* |
547+
| `description` | `string` | Human-readable description. *(from `LayerCommons`)* |
548+
512549
---
513550

514551
### `Prompt`
515552

516-
Prompt artifact definition in a Kitfile.
553+
Prompt artifact definition in a Kitfile. Extends [`LayerCommons`](#layerbase).
517554

518555
```typescript
519-
interface Prompt {
520-
path?: string;
521-
description?: string;
522-
}
556+
interface Prompt extends LayerCommons {}
523557
```
524558

559+
| Property | Type | Description |
560+
|---|---|---|
561+
| `path` | `string` | Path to the prompt file or directory. *(from `LayerCommons`)* |
562+
| `description` | `string` | Human-readable description. *(from `LayerCommons`)* |
563+
525564
---
526565

527566
## Manifest Types

0 commit comments

Comments
 (0)