Skip to content

Commit a649769

Browse files
committed
docs: update spec.md to ensure consistent terminology and clarity
Updated the specification for model artifacts to ensure consistent terminology and clarity. Changes include specifying "model weights files" instead of "model weight file" and refining descriptions for various media types to enhance understanding. Signed-off-by: Zhao Chen <[email protected]>
1 parent 778ed6d commit a649769

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

docs/spec.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The image manifest of model artifacts follows the [OCI Image Manifest Specificat
3030

3131
- **`config`** _[descriptor](config.md)_
3232

33-
This REQUIRED property references a configuration object for a AI/ML model, by digest.
33+
This REQUIRED property references a configuration object for an AI/ML model, by digest.
3434

3535
- **`mediaType`** _string_
3636

@@ -44,43 +44,43 @@ The image manifest of model artifacts follows the [OCI Image Manifest Specificat
4444

4545
- `application/vnd.cncf.model.weight.v1.raw`: The layer is an unarchived, uncompressed model weights file.
4646

47-
- `application/vnd.cncf.model.weight.v1.tar`: The layer is a [tar archive][tar-archive] that contains the model weight file. If the model has multiple weight files, they SHOULD be packaged into separate layers.
47+
- `application/vnd.cncf.model.weight.v1.tar`: The layer is a [tar archive][tar-archive] that contains the model weights file. If the model has multiple weight files, they SHOULD be packaged into separate layers.
4848

49-
- `application/vnd.cncf.model.weight.v1.tar+gzip`: The layer is a [tar archive][tar-archive] that contains the model weight file. The archive is compressed with [gzip][rfc1952_2].
49+
- `application/vnd.cncf.model.weight.v1.tar+gzip`: The layer is a [tar archive][tar-archive] that contains the model weights file. The archive is compressed with [gzip][rfc1952_2].
5050

51-
- `application/vnd.cncf.model.weight.v1.tar+zstd`: The layer is a [tar archive][tar-archive] that contains the model weight file. The archive is compressed with [zstd][rfc8478].
51+
- `application/vnd.cncf.model.weight.v1.tar+zstd`: The layer is a [tar archive][tar-archive] that contains the model weights file. The archive is compressed with [zstd][rfc8478].
5252

53-
- `application/vnd.cncf.model.weight.config.v1.raw`: The layer is an unarchived, uncompressed config of the model weights like tokenizer.json, config.json, etc.
53+
- `application/vnd.cncf.model.weight.config.v1.raw`: The layer is an unarchived, uncompressed configuration file of the model weights like tokenizer.json, config.json, etc.
5454

55-
- `application/vnd.cncf.model.weight.config.v1.tar`: The layer is a [tar archive][tar-archive] that includes config of the model weights like tokenizer.json, config.json, etc.
55+
- `application/vnd.cncf.model.weight.config.v1.tar`: The layer is a [tar archive][tar-archive] that contains configuration files of the model weights like tokenizer.json, config.json, etc.
5656

57-
- `application/vnd.cncf.model.weight.config.v1.tar+gzip`: The layer is a [tar archive][tar-archive] that includes config of the model weights like tokenizer.json, config.json, etc. The archive is compressed with [gzip][rfc1952_2].
57+
- `application/vnd.cncf.model.weight.config.v1.tar+gzip`: The layer is a [tar archive][tar-archive] that contains configuration files of the model weights like tokenizer.json, config.json, etc. The archive is compressed with [gzip][rfc1952_2].
5858

59-
- `application/vnd.cncf.model.weight.config.v1.tar+zstd`: The layer is a [tar archive][tar-archive] that includes config of the model weights like tokenizer.json, config.json, etc. The archive is compressed with [zstd][rfc8478].
59+
- `application/vnd.cncf.model.weight.config.v1.tar+zstd`: The layer is a [tar archive][tar-archive] that contains configuration files of the model weights like tokenizer.json, config.json, etc. The archive is compressed with [zstd][rfc8478].
6060

6161
- `application/vnd.cncf.model.doc.v1.raw`: The layer is an unarchived, uncompressed documentation file.
6262

63-
- `application/vnd.cncf.model.doc.v1.tar`: The layer is a [tar archive][tar-archive] that includes documentation files like `README.md`, `LICENSE`, etc.
63+
- `application/vnd.cncf.model.doc.v1.tar`: The layer is a [tar archive][tar-archive] that contains documentation files like `README.md`, `LICENSE`, etc.
6464

65-
- `application/vnd.cncf.model.doc.v1.tar+gzip`: The layer is a [tar archive][tar-archive] that includes documentation files like `README.md`, `LICENSE`, etc. The archive is compressed with [gzip][rfc1952_2].
65+
- `application/vnd.cncf.model.doc.v1.tar+gzip`: The layer is a [tar archive][tar-archive] that contains documentation files like `README.md`, `LICENSE`, etc. The archive is compressed with [gzip][rfc1952_2].
6666

67-
- `application/vnd.cncf.model.doc.v1.tar+zstd`: The layer is a [tar archive][tar-archive] that includes documentation files like `README.md`, `LICENSE`, etc. The archive is compressed with [zstd][rfc8478].
67+
- `application/vnd.cncf.model.doc.v1.tar+zstd`: The layer is a [tar archive][tar-archive] that contains documentation files like `README.md`, `LICENSE`, etc. The archive is compressed with [zstd][rfc8478].
6868

6969
- `application/vnd.cncf.model.code.v1.raw`: The layer is an unarchived, uncompressed code artifact.
7070

71-
- `application/vnd.cncf.model.code.v1.tar`: The layer is a [tar archive][tar-archive] that includes code artifacts like scripts, code files etc.
71+
- `application/vnd.cncf.model.code.v1.tar`: The layer is a [tar archive][tar-archive] that contains code artifacts like scripts, code files, etc.
7272

73-
- `application/vnd.cncf.model.code.v1.tar+gzip`: The layer is a [tar archive][tar-archive] that includes code artifacts like scripts, code files etc. The archive is compressed with [gzip][rfc1952_2].
73+
- `application/vnd.cncf.model.code.v1.tar+gzip`: The layer is a [tar archive][tar-archive] that contains code artifacts like scripts, code files, etc. The archive is compressed with [gzip][rfc1952_2].
7474

75-
- `application/vnd.cncf.model.code.v1.tar+zstd`: The layer is a [tar archive][tar-archive] that includes code artifacts like scripts, code files etc. The archive is compressed with [zstd][rfc8478].
75+
- `application/vnd.cncf.model.code.v1.tar+zstd`: The layer is a [tar archive][tar-archive] that contains code artifacts like scripts, code files, etc. The archive is compressed with [zstd][rfc8478].
7676

77-
- `application/vnd.cncf.model.dataset.v1.raw`: The layer is an unarchived, uncompressed dataset.
77+
- `application/vnd.cncf.model.dataset.v1.raw`: The layer is an unarchived, uncompressed dataset file.
7878

79-
- `application/vnd.cncf.model.dataset.v1.tar`: The layer is a [tar archive][tar-archive] that includes datasets that may be needed for the lifecycle of AI/ML models.
79+
- `application/vnd.cncf.model.dataset.v1.tar`: The layer is a [tar archive][tar-archive] that contains dataset files that may be needed for the lifecycle of AI/ML models.
8080

81-
- `application/vnd.cncf.model.dataset.v1.tar+gzip`: The layer is a [tar archive][tar-archive] that includes datasets that may be needed for the lifecycle of AI/ML models. The archive is compressed with [gzip][rfc1952_2].
81+
- `application/vnd.cncf.model.dataset.v1.tar+gzip`: The layer is a [tar archive][tar-archive] that contains dataset files that may be needed for the lifecycle of AI/ML models. The archive is compressed with [gzip][rfc1952_2].
8282

83-
- `application/vnd.cncf.model.dataset.v1.tar+zstd`: The layer is a [tar archive][tar-archive] that includes datasets that may be needed for the lifecycle of AI/ML models. The archive is compressed with [zstd][rfc8478].
83+
- `application/vnd.cncf.model.dataset.v1.tar+zstd`: The layer is a [tar archive][tar-archive] that contains dataset files that may be needed for the lifecycle of AI/ML models. The archive is compressed with [zstd][rfc8478].
8484

8585
- **`annotations`** _string-string map_
8686

@@ -127,7 +127,7 @@ The image manifest of model artifacts follows the [OCI Image Manifest Specificat
127127

128128
This section describes how to serialize AI/ML artifacts into a blob called a layer.
129129

130-
**Implementers' note**: It is recommended to package weight files without compression to avoid unnecessary overhead of decompression by the container runtime as model weight files are typically incompressible.
130+
**Implementers note**: It is recommended to package model weights files without compression to avoid unnecessary overhead of decompression by the container runtime as model weights files are typically incompressible.
131131

132132
### `+gzip` Media Types
133133

@@ -139,22 +139,22 @@ The `application/vnd.cncf.model.weight.v1.tar+zstd` represents an `application/v
139139

140140
### File Attributes
141141

142-
Where supported, MUST include file attributes
142+
Where supported, MUST include file attributes:
143143

144144
- Modification Time (`mtime`)
145145
- User ID (`uid`)
146-
- User Name (`uname`) should be ignored on platforms that support User ID (`uid`)
146+
- User Name (`uname`) SHOULD be ignored on platforms that support User ID (`uid`)
147147
- Group ID (`gid`)
148-
- Group Name (`gname`) should be ignored on platforms that support Group ID (`gid`)
148+
- Group Name (`gname`) SHOULD be ignored on platforms that support Group ID (`gid`)
149149
- Mode (`mode`)
150150

151151
### Reproducibility
152152

153-
To ensure tar layers are packaged in a reproducible way, implementation SHOULD adhere to the following guidance:
153+
To ensure tar layers are packaged in a reproducible way, implementations SHOULD adhere to the following guidance:
154154

155-
- If the archive includes multiple files, files should be added to the archive in lexicographical order.
156-
- File metadata (such as modification time, owner/group id) should be set to known, constant values rather than the current values on disk.
157-
- Platform/implementation specific metadata should be omitted from the archive.
155+
- If the archive includes multiple files, files SHOULD be added to the archive in lexicographical order.
156+
- File metadata (such as modification time, owner/group ID) SHOULD be set to known, constant values rather than the current values on disk.
157+
- Platform/implementation specific metadata SHOULD be omitted from the archive.
158158

159159
## Workflow
160160

0 commit comments

Comments
 (0)