Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal for versioning the ilab config file #117

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Proposal for versioning the ilab config file #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions .spellcheck-en-custom.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ hardcoded
hipBLAS
ilab
impactful
incrementing
Inferencing
instantiation
instructlab
Expand Down
25 changes: 25 additions & 0 deletions docs/schema/ilab-config-version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# `ilab` Config.yaml Versioning

## Problem Statement

Currently the `ilab` CLI's configuration file, `config.yaml`, does not contain a version.

The config file in `ilab` version `0.17` cannot be used in future versions of `ilab` due to new mandatory fields and changes to existing fields.

As the configuration file grows, changes, and becomes more complex, versioning is necessary in order to support forwards and backwards compatibility.

## Proposal

The `ilab` configuration file has a new `version` field at the top level of the config.

The value of `version` should start at `1.0.0`.

## Future Considerations

As future development of `ilab` occurs, ramifications and tooling for the versioning the configuration file will need to be determined for users and developers.

Such considerations include but are not limited to:

- Rules for incrementing the version number
- Tooling to support forward compatibility of configuration files
- Limits for the forward and backward compatibility of configuration files