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

Jump to bottom

Pydantic config #189

Merged
merged 53 commits into from
Sep 19, 2024
Merged

Pydantic config #189

merged 53 commits into from
Sep 19, 2024

Conversation

SecretiveShell
Copy link
Contributor

This PR rewrites the configuration logic to be a subclass of a pydantic model. This has the following benefits:

  • type validation for all models
  • single source of truth for all configuration options
  • automatically generate template config files
  • improve type hinting and static analysis
  • remove ambiguity with unknows relating to kwargs
  • remove the need for many unwrap() calls

When a new config option is added to the pydantic models:

  • automatically add new command line arguments
  • automatically add new environment variables
  • automatically add support inside of config.yml

Possible benefits in the future:

  • generate a new config file from the current config at the time of an error to improve debugging
  • generate a new config.yml file with new additions while retaining the current user's config options
  • ship different default configurations on different platforms (e.g docker)

Additional context
This has the side effect of solving #160

@SecretiveShell
config is now backed by pydantic (WIP)
362b8d5 
- add models for config options
- add function to regenerate config.yml
- replace references to config with pydantic compatible references
- remove unnecessary unwrap() statements

TODO:

- auto generate env vars
- auto generate argparse
- test loading a model
@SecretiveShell
automate arg parse
36e991c 
- generate arg parser dynamically
- remove legavy parser code
@SecretiveShell
patch pydantic config into old config
8e93446 
- convert pydantic to dict to avoid errors with current files
- fix formatting
@SecretiveShell
add env var loading automation
420fd84 
- load config from env vars (eg. TABBY_NETWORK_HOST)
- remove print statements
- improve command line args automation
@SecretiveShell SecretiveShell marked this pull request as ready for review September 7, 2024 02:13
@SecretiveShell SecretiveShell mentioned this pull request Sep 8, 2024
Open
SecretiveShell and others added 21 commits September 11, 2024 18:00
@SecretiveShell
remove unused imports
c6f9806
@SecretiveShell
fix line lengths
05f1c3e
@SecretiveShell
fix model names
8b48f00
@SecretiveShell
fix missing rename
e11d80b
@SecretiveShell
add error message for invalid use_as_default
eb5f42c
@SecretiveShell
remove private attributes in args
6e935c5
@bdashore3
Args: Switch to use model_field for everything
21747bf 
Pydantic provides these helpers. Better to use these instead of
the inspect lib.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Fix descriptions
d5b3fde 
Appending lines also requires a space between each one otherwise
they'll squish together.

Signed-off-by: kingbri <bdashore3@proton.me>
@SecretiveShell
make pydantic do all the validation
dc4946b
@SecretiveShell
remove unnecessary code
533e7c9
@SecretiveShell
add export openAPI to config
0903f85
@bdashore3
Config: Cleanup and organize functions
a09dd80 
Remove access of private attributes and use safer functions. Also
move generalized functions into utils files.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Logging: Remove preferences global
6f28cfe 
This is no longer needed because config is a singleton.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Add aliases for logging config
d013729 
Config.yml and args take in two different values.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Actions: Format
5bfa952 
Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Merge branch 'main' into pydantic-config
f05229b
@SecretiveShell
improve config generation action
92af656
@bdashore3
Config: Alter YAML generator function
250d76f 
These changes fix the amount and order of newlines to look pleasing
for the user. However, the changes used in here are kind of hacky
and need a proper fix that can contain the same level of efficiency.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Rewrite docstrings for models
8ff9f2c 
Adheres to the old config.yml's descriptions and allows for newlines
in generated YAML.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Reorder models
4c8bb42 
It makes sense for the LLM model groups to be clustered around
each other with the least used groups towards the bottom.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Rewrite descriptions
3340c3b 
This makes both config.yml and args more descriptive than before.

Signed-off-by: kingbri <bdashore3@proton.me>
bdashore3 and others added 25 commits September 16, 2024 00:55
@bdashore3
Config: Handle default factories in config generation
b6dd21f 
Signed-off-by: kingbri <bdashore3@proton.me>
@SecretiveShell
add legacy config converter
564bdcf
@SecretiveShell
rephrase info message
7f03003
@bdashore3
Config: Allow existing values to get included in generated file
81ae461 
Allows for generation from an existing config file. Primarily used
for migration purposes.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Add logging config to migration checks
c715094 
These keys were changed as well to include a "log_" prefix like the
CLI arguments.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Fix existing value check
e60c4ba 
If a sub-field exists in the model provided to the file generator,
use it. Otherwise always fallback to the default factory. This prevents
any subsequent errors from setting None.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Alter migration error handling and cleanup
ebe7f35 
Rollback to the old config if automigration fails.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Update auto-migration flow
d2d07ed 
- Let the user know that migration is going to be attempted
- Have a more informative error message if auto-migration fails
- Revert back to the old config file on failure
- Don't load with a partially parsed config

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Move config file generation to tabby_config
46f9fff 
Keep the models as a separate reference file without any extra
functions.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Main: Remove debug print statement for config object
06a798d 
Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
API: Fix model info reporting
26ad0ef 
A deprecated preferences global var was being referenced.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Update .gitignore
8e6b8bd 
Ignore all "backup" files

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Inline model loading is False
f6fb60a 
This is not a True default.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Fix addition of preamble
ececce1 
Remove the extraneous newlines from the beginning of the preamble.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Don't load from file if actions present
852ea8f 
Loading from file adds extra overhead for actions that don't rely
on file loading.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Make a better description for lora config
63f8c46 
This is not ideal because users may still have trouble understanding
what a lora includes, but adding an example comment will help instead
of leaving a blank line.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Tree: Update config_sample
7fe0dbd 
Uses the new YAML generator.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
API: Upgrade config declarations
daa57ce 
Some were using the old unwrap methods.

Signed-off-by: kingbri <bdashore3@proton.me>
@SecretiveShell
fix defaults for api_servers
bb4dd72
@SecretiveShell
migrate to ruamel.yaml
948fcb7
@bdashore3
Config: Alter YAML generation script for formatting adherence
a34bd9a 
Properly add comments and newlines where they need to go.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Fix draft model migration and loading
754fb15 
The loader takes in the "draft" parameter, so map the config model
to that when creating kwargs for initial load.

Also map the old "draft" key to the new "draft_model" key.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Config: Clarify Rope alpha options
63634be 
Leaving blank will use the model's set value or auto-calculate.

Signed-off-by: kingbri <bdashore3@proton.me>
@SecretiveShell
migrate all yaml loaders to ruamel.yaml
6c7542d
@bdashore3
Tree: Use safe loader for YAML
24ea85b 
Loaders that read use a safe type while loaders that write use both
round-trip and safe options.

Also don't create module-level parsers where they're not needed.

Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3
Tree: Format
4cf8551 
Signed-off-by: kingbri <bdashore3@proton.me>
@bdashore3 bdashore3 merged commit 03189bc into theroyallab:main Sep 19, 2024
1 check passed
@bdashore3 bdashore3 mentioned this pull request Sep 20, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@SecretiveShell @bdashore3