Skip to content

Commit 3de39c2

Browse files
authored
Updated docs for config. (#450)
1 parent 61b9791 commit 3de39c2

File tree

1 file changed

+29
-20
lines changed

1 file changed

+29
-20
lines changed

docs/source/users/index.md

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -949,9 +949,35 @@ following section.
949949

950950
#### Configuring as a config file
951951

952-
This configuration can also be specified in a config file in json format. The
953-
file should be named `jupyter_jupyter_ai_config.json` and saved in a path that
954-
JupyterLab can pick from. You can find this path by running `jupyter --paths`
952+
This configuration can also be specified in a config file in json format.
953+
954+
Here is an example for configuring the `bedrock` provider for `ai21.j2-mid-v1`
955+
model.
956+
957+
```json
958+
{
959+
"AiExtension": {
960+
"model_parameters": {
961+
"bedrock:ai21.j2-mid-v1": {
962+
"model_kwargs": {
963+
"maxTokens": 200
964+
}
965+
}
966+
}
967+
}
968+
}
969+
```
970+
971+
There are several ways to specify JupyterLab to pick this config.
972+
973+
The first option is to save this config in a file and specifying the filepath at startup using the `--config` or `-c` option.
974+
975+
```bash
976+
jupyter lab --config <config-file-path>
977+
```
978+
979+
The second option is to drop it in a location that JupyterLab scans for configuration files.
980+
The file should be named `jupyter_jupyter_ai_config.json` in this case. You can find these paths by running `jupyter --paths`
955981
command, and picking one of the paths from the `config` section.
956982

957983
Here is an example of running the `jupyter --paths` command.
@@ -973,20 +999,3 @@ data:
973999
runtime:
9741000
/Users/3coins/Library/Jupyter/runtime
9751001
```
976-
977-
Here is an example for configuring the `bedrock` provider for `ai21.j2-mid-v1`
978-
model.
979-
980-
```json
981-
{
982-
"AiExtension": {
983-
"model_parameters": {
984-
"bedrock:ai21.j2-mid-v1": {
985-
"model_kwargs": {
986-
"maxTokens": 200
987-
}
988-
}
989-
}
990-
}
991-
}
992-
```

0 commit comments

Comments
 (0)