aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGravatar Reinier van der Leer <pwuts@agpt.co> 2023-12-05 16:28:23 +0100
committerGravatar GitHub <noreply@github.com> 2023-12-05 16:28:23 +0100
commit7b05245286a25ca90ee44c0e200a0a75efeb4d78 (patch)
treee99c8abb327db593bc963a3259ed86cdfbdbcbbc /docs
parentRoll back cassette updates (diff)
downloadAuto-GPT-7b05245286a25ca90ee44c0e200a0a75efeb4d78.tar.gz
Auto-GPT-7b05245286a25ca90ee44c0e200a0a75efeb4d78.tar.bz2
Auto-GPT-7b05245286a25ca90ee44c0e200a0a75efeb4d78.zip
refactor(agent/config): Modularize `Config` and revive Azure support (#6497)
* feat: Refactor config loading and initialization to be modular and decentralized - Refactored the `ConfigBuilder` class to support modular loading and initialization of the configuration from environment variables. - Implemented recursive loading and initialization of nested config objects. - Introduced the `SystemConfiguration` base class to provide common functionality for all system settings. - Added the `from_env` attribute to the `UserConfigurable` decorator to provide environment variable mappings. - Updated the `Config` class and its related classes to inherit from `SystemConfiguration` and use the `UserConfigurable` decorator. - Updated `LoggingConfig` and `TTSConfig` to use the `UserConfigurable` decorator for their fields. - Modified the implementation of the `build_config_from_env` method in `ConfigBuilder` to utilize the new modular and recursive loading and initialization logic. - Updated applicable test cases to reflect the changes in the config loading and initialization logic. This refactor improves the flexibility and maintainability of the configuration loading process by introducing modular and recursive behavior, allowing for easier extension and customization through environment variables. * refactor: Move OpenAI credentials into `OpenAICredentials` sub-config - Move OpenAI API key and other OpenAI credentials from the global config to a new sub-config called OpenAICredentials. - Update the necessary code to use the new OpenAICredentials sub-config instead of the global config when accessing OpenAI credentials. - (Hopefully) unbreak Azure support. - Update azure.yaml.template. - Enable validation of assignment operations on SystemConfiguration and SystemSettings objects. * feat: Update AutoGPT configuration options and setup instructions - Added new configuration options for logging and OpenAI usage to .env.template - Removed deprecated configuration options in config/config.py - Updated setup instructions in Docker and general setup documentation to include information on using Azure's OpenAI services * fix: Fix image generation with Dall-E - Fix issue with image generation with Dall-E API Additional user context: This commit fixes an issue with image generation using the Dall-E API. The code now correctly retrieves the API key from the agent's legacy configuration. * refactor(agent/core): Refactor `autogpt.core.configuration.schema` and update docstrings - Refactor the `schema.py` file in the `autogpt.core.configuration` module. - Added docstring to `SystemConfiguration.from_env()` - Updated docstrings for functions `_get_user_config_values`, `_get_non_default_user_config_values`, `_recursive_init_model`, `_recurse_user_config_fields`, and `_recurse_user_config_values`.
Diffstat (limited to 'docs')
-rw-r--r--docs/content/AutoGPT/setup/docker.md2
-rw-r--r--docs/content/AutoGPT/setup/index.md22
2 files changed, 23 insertions, 1 deletions
diff --git a/docs/content/AutoGPT/setup/docker.md b/docs/content/AutoGPT/setup/docker.md
index 4d3000c5a..35bd7c2c1 100644
--- a/docs/content/AutoGPT/setup/docker.md
+++ b/docs/content/AutoGPT/setup/docker.md
@@ -144,7 +144,7 @@ found in the [repository].
**Note:** Azure support has been dropped in `master`, so these instructions will only work with v0.4.7 (or earlier).
-[repository]: https://github.com/Significant-Gravitas/AutoGPT/autogpts/autogpt
+[repository]: https://github.com/Significant-Gravitas/AutoGPT/tree/master/autogpts/autogpt
[show hidden files/Windows]: https://support.microsoft.com/en-us/windows/view-hidden-files-and-folders-in-windows-97fbc472-c603-9d90-91d0-1166d1d9f4b5
[show hidden files/macOS]: https://www.pcmag.com/how-to/how-to-access-your-macs-hidden-files
[openai-python docs]: https://github.com/openai/openai-python#microsoft-azure-endpoints
diff --git a/docs/content/AutoGPT/setup/index.md b/docs/content/AutoGPT/setup/index.md
index 2bf6724f4..5ef214b61 100644
--- a/docs/content/AutoGPT/setup/index.md
+++ b/docs/content/AutoGPT/setup/index.md
@@ -88,6 +88,28 @@ Once you have cloned or downloaded the project, you can find the AutoGPT Agent i
```yaml
OPENAI_API_KEY=sk-qwertykeys123456
```
+
+ !!! info "Using a GPT Azure-instance"
+ If you want to use GPT on an Azure instance, set `USE_AZURE` to `True` and
+ make an Azure configuration file.
+
+ Rename `azure.yaml.template` to `azure.yaml` and provide the relevant
+ `azure_api_base`, `azure_api_version` and deployment IDs for the models that you
+ want to use.
+
+ E.g. if you want to use `gpt-3.5-turbo-16k` and `gpt-4-0314`:
+
+ ```yaml
+ # Please specify all of these values as double-quoted strings
+ # Replace string in angled brackets (<>) to your own deployment Name
+ azure_model_map:
+ gpt-3.5-turbo-16k: "<auto-gpt-deployment>"
+ ...
+ ```
+
+ Details can be found in the [openai-python docs], and in the [Azure OpenAI docs] for the embedding model.
+ If you're on Windows you may need to install an [MSVC library](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).
+
6. Enter any other API keys or tokens for services you would like to use.
!!! note