You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: docs/docker-model-runner.md
+19-12Lines changed: 19 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,20 +81,27 @@ If any of these fields are present, the artifact is recognized as a ModelPack-fo
81
81
82
82
## Field Mapping: ModelPack to Docker
83
83
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:
85
85
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 |
87
97
|---|---|---|
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) |
0 commit comments