Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/10919/badge)](https://www.bestpractices.dev/projects/10919)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmodelpack%2Fmodel-spec.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmodelpack%2Fmodel-spec?ref=badge_shield)

The Cloud Native Computing Foundation's (CNCF) ModelPack project is a vendor-neutral, open source specification standard to package, distribute and run AI models in a cloud native environments. It's goal is to enable the creation of standard-compliant implementations that would move AI/ML project artifacts out of vendor-controlled, proprietary formats and into a standardized and interchangeable format that is compatible with the cloud-native ecosystem.
The Cloud Native Computing Foundation's (CNCF) ModelPack project is a vendor-neutral, open source specification standard to package, distribute and run AI models in cloud native environments. Its goal is to enable the creation of standard-compliant implementations that would move AI/ML project artifacts out of vendor-controlled, proprietary formats and into a standardized and interchangeable format that is compatible with the cloud-native ecosystem.

## Rationale

Expand Down
2 changes: 1 addition & 1 deletion docs/annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This property contains arbitrary metadata, and SHOULD follow the rules of [OCI i

- **`org.cncf.model.filepath`**: Specifies the file path of the layer (string).

- **`org.cncf.model.file.metadata+json`**: Specifies the metadata of the file (string), value is the JSON string of [File Metadata Annotation Value](#File-Metadata-Annotation-Value).
- **`org.cncf.model.file.metadata+json`**: Specifies the metadata of the file (string), value is the JSON string of [File Metadata Annotation Value](#file-metadata-annotation-value).

- **`org.cncf.model.file.mediatype.untested`**: Indicates whether the media type classification of files in the layer is untested (string). Valid values are `"true"` or `"false"`. When set to `"true"`, it signals that the model packager has not verified the media type classification and the type is inferred or assumed based on some heuristics.

Expand Down
4 changes: 2 additions & 2 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,12 +138,12 @@ The following terms are used in this section:
- **inputTypes** _array of string_, OPTIONAL

An array of strings specifying the data types that the model can accept as input.
The allowed values are: "text", "image", "audio", "video", or "embedding". For input types that are not explicitly defined, the value "other" value should be used.
The allowed values are: "text", "image", "audio", "video", or "embedding". For input types that are not explicitly defined, the value "other" should be used.

- **outputTypes** _array of string_, OPTIONAL

An array of strings specifying the data types that the model can produce as output.
The allowed values are: "text", "image", "audio", "video", or "embedding". For output types that are not explicitly defined, the value "other" value should be used.
The allowed values are: "text", "image", "audio", "video", or "embedding". For output types that are not explicitly defined, the value "other" should be used.

- **knowledgeCutoff** _string_, OPTIONAL

Expand Down
2 changes: 1 addition & 1 deletion schema/example_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ func validate(t *testing.T, name string) {

if example.Err != nil {
printFields(t, "error", example.Mediatype, example.Title, example.Err)
t.Error(err)
t.Error(example.Err)
continue
}

Expand Down
2 changes: 1 addition & 1 deletion schema/validator.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ func (v Validator) Validate(src io.Reader) error {
// run the media type specific validation
if fn, ok := validateByMediaType[v]; ok {
if fn == nil {
return fmt.Errorf("internal error: mapValidate is nil for %s", string(v))
return fmt.Errorf("internal error: validateByMediaType entry is nil for %s", string(v))
}
// buffer the src so the media type validation and the schema validation can both read it
buf, err := io.ReadAll(src)
Expand Down
4 changes: 2 additions & 2 deletions specs-go/v1/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ type ModelConfig struct {
Capabilities *ModelCapabilities `json:"capabilities,omitempty"`
}

// ModelFS describes a layer content addresses
// ModelFS describes the layer content addresses of a model
type ModelFS struct {
// Type is the type of the rootfs. MUST be set to "layers".
Type string `json:"type"`
Expand Down Expand Up @@ -163,7 +163,7 @@ type Model struct {
// The model descriptor
Descriptor ModelDescriptor `json:"descriptor"`

// The model describes a layer content addresses
// ModelFS describes the layer content addresses of the model
ModelFS ModelFS `json:"modelfs"`

// Config defines the execution parameters which should be used as a base when running a model using an inference engine.
Expand Down