Skip to content

Commit e7e2f63

Browse files
committed
Clarify field mapping table in Docker Model Runner docs
Split the mapping table into renamed vs pass-through fields to make the Docker internal structure clearer per review feedback. Signed-off-by: Pradhyum <pradhyum314@gmail.com> Signed-off-by: pradhyum6144 <pradhyum314@gmail.com>
1 parent 2004b6f commit e7e2f63

1 file changed

Lines changed: 19 additions & 12 deletions

File tree

docs/docker-model-runner.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -81,20 +81,27 @@ If any of these fields are present, the artifact is recognized as a ModelPack-fo
8181

8282
## Field Mapping: ModelPack to Docker
8383

84-
When Docker Model Runner pulls a ModelPack model, it converts the config fields to Docker's internal format:
84+
When Docker Model Runner pulls a ModelPack model, it converts the config to Docker's internal format. Some fields are remapped to different names or locations:
8585

86-
| ModelPack Field | Docker Field | Description |
86+
**Fields that are renamed (breaking changes if modified):**
87+
88+
| ModelPack Field | Docker Field | Notes |
89+
|---|---|---|
90+
| `descriptor.createdAt` | `created` (top-level) | Moved out of `descriptor` and renamed |
91+
| `config.paramSize` | `parameters` (top-level) | Moved out of `config` and renamed |
92+
| `modelfs` (top-level object) | `rootfs` (top-level object) | Renamed at top level |
93+
94+
**Fields that are passed through unchanged (within their parent objects):**
95+
96+
| ModelPack Field | Docker Field | Notes |
8797
|---|---|---|
88-
| `descriptor.createdAt` | `created` | Model creation timestamp |
89-
| `descriptor.name` | `descriptor.name` | Model name |
90-
| `descriptor.family` | `descriptor.family` | Model family |
91-
| `descriptor.description` | `descriptor.description` | Model description |
92-
| `descriptor.licenses` | `descriptor.licenses` | License information |
93-
| `config.paramSize` | `parameters` | Model parameter count |
94-
| `config.format` | `config.format` | Model format (e.g., GGUF) |
95-
| `config.quantization` | `config.quantization` | Quantization method |
96-
| `config.architecture` | `config.architecture` | Model architecture |
97-
| `modelfs` | `rootfs` | Layer content addresses |
98+
| `descriptor.name` | `descriptor.name` | Kept in `descriptor` object |
99+
| `descriptor.family` | `descriptor.family` | Kept in `descriptor` object |
100+
| `descriptor.description` | `descriptor.description` | Kept in `descriptor` object |
101+
| `descriptor.licenses` | `descriptor.licenses` | Kept in `descriptor` object |
102+
| `config.format` | `config.format` | Kept in `config` object |
103+
| `config.quantization` | `config.quantization` | Kept in `config` object |
104+
| `config.architecture` | `config.architecture` | Kept in `config` object |
98105

99106
## Media Type Mapping
100107

0 commit comments

Comments
 (0)