diff --git a/README.md b/README.md index e5fa6d7..acf8589 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/annotations.md b/docs/annotations.md index 3126997..df60daa 100644 --- a/docs/annotations.md +++ b/docs/annotations.md @@ -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. diff --git a/docs/config.md b/docs/config.md index 0c505bf..8531c85 100644 --- a/docs/config.md +++ b/docs/config.md @@ -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 diff --git a/schema/example_test.go b/schema/example_test.go index 67661cc..d93bde7 100644 --- a/schema/example_test.go +++ b/schema/example_test.go @@ -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 } diff --git a/schema/validator.go b/schema/validator.go index 77df610..67f18be 100644 --- a/schema/validator.go +++ b/schema/validator.go @@ -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) diff --git a/specs-go/v1/config.go b/specs-go/v1/config.go index 4462cdd..4396ac1 100644 --- a/specs-go/v1/config.go +++ b/specs-go/v1/config.go @@ -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"` @@ -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.