Dev doc for the configuration file redesign #162
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Ali Maredia <[email protected]>
|
|
||
| This document represents the next step in the evolution of the configuration of the `ilab` CLI. | ||
| Ever since `ilab` was created, it relied upon the existence of configuration file written in YAML. | ||
| The current state of the config is documented [here](https://github.com/instructlab/dev-docs/pull/132). |
There was a problem hiding this comment.
I've just closed this PR as it's been abandoned - I would say remove this line
|
|
||
| Throughout this document the terms "configuration", and "profile" will be used. The term "configuration" describes the entire internal data structure within `ilab` for configuration used when a command is run. | ||
|
|
||
| A "profile" is a subset of configuration needed to allow `ilab` to function optimally on a given piece of hardware. When applied a profile overrides the provided subset of configuration. |
There was a problem hiding this comment.
Suggested change
| A "profile" is a subset of configuration needed to allow `ilab` to function optimally on a given piece of hardware. When applied a profile overrides the provided subset of configuration. | |
| A "profile" is a subset of configuration needed to allow `ilab` to function optimally on a given piece of hardware. When applied, a profile overrides the provided subset of configuration. |
Comment on lines
+52
to
+53
| 1. (System Internal) DefaultConfig data structure AKA the system defaults | ||
| 2. (System Internal) Hardware & System Profile auto-detection |
There was a problem hiding this comment.
Suggested change
| 1. (System Internal) DefaultConfig data structure AKA the system defaults | |
| 2. (System Internal) Hardware & System Profile auto-detection | |
| 1. (System Internal) DefaultConfig data structure AKA the code defaults | |
| 2. (System Internal) System Profile configuration (if applicable) |
|
|
||
| 1. (System Internal) DefaultConfig data structure AKA the system defaults | ||
| 2. (System Internal) Hardware & System Profile auto-detection | ||
| 3. (User provided) A configuration file |
There was a problem hiding this comment.
Suggested change
| 3. (User provided) A configuration file | |
| 3. (User provided) A configuration file (like the current `config.yaml`) |
| 1. (System Internal) DefaultConfig data structure AKA the system defaults | ||
| 2. (System Internal) Hardware & System Profile auto-detection | ||
| 3. (User provided) A configuration file | ||
| 4. (User provided) Flags for a specific command to override specific configuration variables |
There was a problem hiding this comment.
Suggested change
| 4. (User provided) Flags for a specific command to override specific configuration variables | |
| 4. (User provided) Flags for a specific command to override specific configuration variables (such as `--gpus` in `ilab model serve`) |
|
|
||
| The value(s) shown would reflect the configuration after profile auto-detection and user provided configuration files are applied. | ||
|
|
||
| `ilab config show` could also be a starting point for new configuration files. |
There was a problem hiding this comment.
I think this should be a config generate feature
|
|
||
| Currently `ilab` needs a configuration file to function. The goal of this phase of development is to decouple `ilab` from needing a configuration file, and to establish a clear hierarchy for users to understand how their configuration is set. | ||
|
|
||
| Configuration overrides happen both internally within `ilab`, and with user provided overrides. |
There was a problem hiding this comment.
Suggested change
| Configuration overrides happen both internally within `ilab`, and with user provided overrides. | |
| Configuration overrides happen both internally within `ilab`, and with user-provided overrides. |
|
|
||
| ### Phase 1.2: System Profile Auto-detection | ||
|
|
||
| Maximizing the effectiveness of Instructlab involves changing the configuration to specify specific models, and configuration parameters. These changes depend on the hardware `ilab` is running on. |
There was a problem hiding this comment.
Suggested change
| Maximizing the effectiveness of Instructlab involves changing the configuration to specify specific models, and configuration parameters. These changes depend on the hardware `ilab` is running on. | |
| Maximizing the effectiveness of InstructLab involves changing the configuration to specify specific models, and configuration parameters. These changes depend on the hardware `ilab` is running on. |
| Set default configuration | ||
| ``` | ||
|
|
||
| ### Phase 1.3: User provided configuration file |
There was a problem hiding this comment.
Suggested change
| ### Phase 1.3: User provided configuration file | |
| ### Phase 1.3: User-provided configuration file |
| ... | ||
| ``` | ||
|
|
||
| ### Phase 1.4: User provided flags |
There was a problem hiding this comment.
Suggested change
| ### Phase 1.4: User provided flags | |
| ### Phase 1.4: User-provided flags |
reidliu41
reviewed
Dec 19, 2024
| $ ilab model serve | ||
| ... | ||
| WARNING found configuration files at /home/ec2-user/.confg/instructlab/config.toml and /home/ec2-user/.config/instructlab/config.yaml. Configuration files not applied. | ||
| ... |
There was a problem hiding this comment.
or can it read a default one, and show the WARNING too?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.