Skip to content

Commit

Permalink
chore(docs): changed configuration index
Browse files Browse the repository at this point in the history
* chore(docs): changed configuration index
  • Loading branch information
francis2tm authored Feb 26, 2024
1 parent 15ee279 commit a264b27
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/src/app/documentation/configuration/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ The Edgen configuration. It is read from a file where you can define your models
| `audio_transcriptions_model_repo` | HuggingFace repo for audio transcriptions | distil-whisper/distil-small.en |
| `gpu_policy` | Policy to choose how a model gets loaded | !always_device |

### Configuration Paths for DATA_DIR
## Configuration Paths for DATA_DIR

| Platform | Value | Example |
| -------- | ----------------------------------------------------------------- | ------------------------------------------------- |
| Linux | `$XDG_DATA_HOME/_project_path_` or `$HOME/.local/share/_project_path_` | `/home/Alex/.local/share/edgen` |
| macOS | `$HOME/Library/Application Support/_project_path_` | `/Users/Alex/Library/Application Support/com.EdgenAI.Edgen` |
| Windows | `{FOLDERID_RoamingAppData}\_project_path_\data` | `C:\Users\Alex\AppData\Roaming\EdgenAI\Edgen\data` |

### Model Name and Repo
## Model Name and Repo

Model name and repo define the model to use and how to obtain it automatically. If you download the model yourself you just have to copy it to the corresponding model directory and set the `model_name` setting to the file name. The repo has only informative character in this case, for instance:

Expand All @@ -44,14 +44,14 @@ If you prefer to let Edgen manage your models, you need to fill in the correct m
| `chat_completions_model_name` | fancy-model-1.v1-1.gguf |
| `chat_completions_model_repo` | ModelMaster/fancy-model-1.v1-1.GGUF |

In this case, if the model does not exist in the model directory, Edgen will automatically download for you. You can use the model manager ([API Reference » Models](/api-reference/models)) to inspect and delete automatically downloaded models.
In this case, if the model does not exist in the model directory, Edgen will automatically download for you. You can use the model manager ([API Reference » Models](/api-reference/models)) to inspect and delete automatically downloaded models.

### GPU policies
## GPU policies

Edgen supports the following policies, each with their own sub-settings:

- `!always_device` - Models will always get loaded to a GPU.
- `overflow_to_cpu` - If true, when a model can't be loaded to a GPU, it gets loaded to system memory. Else, Edgen will free GPU memory until the model can be loaded. **WARNING**: neither of these systems are currently implemented.
- `!always_cpu` - Models will always get loaded to system memory.
- `overflow_to_device` - If true, when a model can't be loaded to system memory, it gets loaded to a GPU. Else, Edgen will free system memory until the model can be loaded. **WARNING**: neither of these systems are currently implemented.

0 comments on commit a264b27

Please sign in to comment.