Skip to content

Update kitops-ts documentation #1152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
javisperez merged 2 commits into from
Mar 31, 2026
Merged

Update kitops-ts documentation #1152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37b376e
Update kitops-ts documentation
Mar 31, 2026
3b3edd9
Update types.md
javisperez Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/docs/kitops-ts/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const yaml = buildKitfile({
model: {
name: 'sentiment-classifier',
path: './model/weights.pt',
format: 'pytorch',
framework: 'pytorch',
},
datasets: [
{ name: 'training-set', path: './data/train.csv', license: 'CC-BY-4.0' },
Expand Down
101 changes: 70 additions & 31 deletions docs/src/docs/kitops-ts/types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,31 +427,49 @@ type Package = {

---

### `LayerCommons`

Base interface extended by all Kitfile layer types. Provides the common `path` and `description` fields.

```typescript
interface LayerCommons {
path: string;
description?: string;
}
```

| Property | Type | Description |
|---|---|---|
| `path` | `string` | Path to the artifact file or directory. |
| `description` | `string` | Human-readable description. |

---

### `Model`

Model artifact definition in a Kitfile.
Model artifact definition in a Kitfile. Extends [`LayerCommons`](#layerbase).

```typescript
interface Model {
interface Model extends LayerCommons {
name?: string;
path?: string;
parts?: ModelPart[];
framework?: string;
version?: string;
license?: string;
description?: string;
format?: string;
parameters?: Record<string, string | number>;
parts?: ModelPart[];
parameters?: unknown;
}
```

| Property | Type | Description |
|---|---|---|
| `path` | `string` | Path to the model file or directory. *(from `LayerCommons`)* |
| `description` | `string` | Human-readable description. *(from `LayerCommons`)* |
| `name` | `string` | Display name for the model. |
| `path` | `string` | Path to the model file or directory. |
| `parts` | [`ModelPart[]`](#modelpart) | Sub-parts of a composite model (e.g. split weight files). |
| `framework` | `string` | ML framework (e.g. `'pytorch'`, `'tensorflow'`). |
| `version` | `string` | Model version. |
| `license` | `string` | SPDX license identifier. |
| `description` | `string` | Human-readable description. |
| `format` | `string` | Model format (e.g. `'gguf'`, `'safetensors'`). |
| `parameters` | `Record<string, string \| number>` | Arbitrary model parameters (e.g. context length, quantization). |
| `parts` | [`ModelPart[]`](#modelpart) | Sub-parts of a composite model (e.g. split weight files). |
| `parameters` | `unknown` | Arbitrary model parameters. |

---

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

```typescript
interface ModelPart {
name?: string;
path?: string;
type?: string;
license?: string;
}
```

| Property | Type | Description |
|---|---|---|
| `name` | `string` | Display name for this part. |
| `path` | `string` | Path to the part file. |
| `type` | `string` | Part type identifier. |

---

### `Dataset`

Dataset artifact definition in a Kitfile.
Dataset artifact definition in a Kitfile. Extends [`LayerCommons`](#layerbase).

```typescript
interface Dataset {
interface Dataset extends LayerCommons {
name?: string;
path?: string;
description?: string;
license?: string;
parameters?: unknown;
}
```

| Property | Type | Description |
|---|---|---|
| `path` | `string` | Path to the dataset file or directory. *(from `LayerCommons`)* |
| `description` | `string` | Human-readable description. *(from `LayerCommons`)* |
| `name` | `string` | Display name for the dataset. |
| `license` | `string` | SPDX license identifier. |
| `parameters` | `unknown` | Arbitrary dataset parameters. |

---

### `Code`

Source code artifact definition in a Kitfile.
Source code artifact definition in a Kitfile. Extends [`LayerCommons`](#layerbase).

```typescript
interface Code {
path: string;
description: string;
interface Code extends LayerCommons {
license?: string;
}
```

| Property | Type | Description |
|---|---|---|
| `path` | `string` | Path to the source code file or directory. *(from `LayerCommons`)* |
| `description` | `string` | Human-readable description. *(from `LayerCommons`)* |
| `license` | `string` | SPDX license identifier. |

---

### `Doc`

Documentation artifact definition in a Kitfile.
Documentation artifact definition in a Kitfile. Extends [`LayerCommons`](#layerbase).

```typescript
interface Doc {
path: string;
description: string;
}
interface Doc extends LayerCommons {}
```

| Property | Type | Description |
|---|---|---|
| `path` | `string` | Path to the documentation file or directory. *(from `LayerCommons`)* |
| `description` | `string` | Human-readable description. *(from `LayerCommons`)* |

---

### `Prompt`

Prompt artifact definition in a Kitfile.
Prompt artifact definition in a Kitfile. Extends [`LayerCommons`](#layerbase).

```typescript
interface Prompt {
path?: string;
description?: string;
}
interface Prompt extends LayerCommons {}
```

| Property | Type | Description |
|---|---|---|
| `path` | `string` | Path to the prompt file or directory. *(from `LayerCommons`)* |
| `description` | `string` | Human-readable description. *(from `LayerCommons`)* |

---

## Manifest Types
Expand Down
Loading