Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
victordibia committed Sep 23, 2023
1 parent 73f336c commit eea073f
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 8 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ export PALM_PROJECT_ID=<your gcp project id>
export PALM_PROJECT_LOCATION=<your project location>
```

You can also set the default provider via a config file. Use the yaml format in this [sample `config.default.yml` file](configs/config.default.yml) and set the `LLMX_CONFIG_PATH` to the path of the config file.

```python
from llmx import llm
from llmx.datamodel import TextGenerationConfig
Expand Down
36 changes: 29 additions & 7 deletions configs/config.default.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,40 @@
# Sets the the default model to use for llm() when no provider parameter is set.

model:
provider: azureopenai
provider: openai
parameters:
api_key: <your-api-key>
api_type: azure
api_base: <your-api-base>
api_version: <your-api-version>
organization: <your-organization> # or null
model: <your-model>
api_key: null
# example with azureopenai model
# model:
# provider: azureopenai
# parameters:
# api_key: <your-api-key>
# api_type: azure
# api_base: <your-api-base>
# api_version: <your-api-version>
# organization: <your-organization> # or null
# model: <your-model>

# example with huggingface model
# model:
# provider: huggingface
# parameters:
# model: uukuguy/speechless-llama2-hermes-orca-platypus-13b
# device_map: auto
# trust_remote_code: true

# # example palm via vertex ai
# model:
# provider: palm
# parameters:
# model: chat-bison@001
# project_id: <your-project-id>
# project_location: <your-project-location>
# palm_key_file: <path-to-your-palm-key-file>

# # example palm via makersuite
# model:
# provider: palm
# parameters:
# model: chat-bison-001
# api_key: <your-makersuite-api-key>
2 changes: 1 addition & 1 deletion llmx/version.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
VERSION = "0.0.12a"
VERSION = "0.0.13a"
APP_NAME = "llmx"

0 comments on commit eea073f

Please sign in to comment.