Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

Document/formalize YAML schema for .mlem files #161

Open
aguschin opened this issue Jun 21, 2022 · 2 comments
Open

Document/formalize YAML schema for .mlem files #161

aguschin opened this issue Jun 21, 2022 · 2 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/{command,api,object}-reference

Comments

@aguschin
Copy link
Contributor

aguschin commented Jun 21, 2022

... no need to include the schema in the README but probably somewhere for reference in the docs.

Also consider creating something like https://github.com/iterative/dvcyaml-schema

Originally posted by @jorgeorpinel in iterative/mlem#220 (comment)

@aguschin aguschin added the A: docs Area: user documentation (gatsby-theme-iterative) label Jun 21, 2022
@aguschin
Copy link
Contributor Author

.mlem yaml schema is dependent on the type of the object. For model, data, deployment, etc, it will be a different schema. IIRC, this is the reason why we cannot easily create the schema as DVC can. We can take a look later, but this is not the priority rn.

@jorgeorpinel jorgeorpinel transferred this issue from iterative/mlem Aug 24, 2022
@jorgeorpinel jorgeorpinel added the C: ref Content of /doc/{command,api,object}-reference label Aug 24, 2022
@jorgeorpinel jorgeorpinel changed the title Generate yaml schema for .mlem files Document/formalize YAML schema for .mlem files Aug 24, 2022
@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Aug 25, 2022

.mlem yaml schema is dependent on the type of the object

@aguschin we should start by listing the types of objects that can exist in .mlem files and general schema for them (model, data, deployment). This will help also improve the configuration docs (rel to -c option).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/{command,api,object}-reference
Projects
None yet
Development

No branches or pull requests

2 participants