Skip to content

Add documentation about custom model configuration - #36

Merged
brichet merged 2 commits into
QuantStack:mainfrom
cmarmo:naut-config
Aug 19, 2026
Merged

Add documentation about custom model configuration#36
brichet merged 2 commits into
QuantStack:mainfrom
cmarmo:naut-config

Conversation

@cmarmo

@cmarmo cmarmo commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Dear maintainers this pull request adds some details about non-interactive custom model configuration in JupyterNaut.
Thanks for considering it.

@github-actions

Copy link
Copy Markdown

Binder 👈 Launch a Binder on branch cmarmo/jupyter-ai-tutor/naut-config

@brichet brichet left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @cmarmo for the documentation.

Should this configuration go in the section Configuration > jupyternaut ?

Comment thread README.md Outdated

Once Jupyterlab started, the model must be configured via the menu `Settings>Jupyternaut settings` (model and API key).
It is also possible to configure your custom model directly via the JupyterNaut configuration file
`.local/share/jupyter/jupyter_ai/config.json`, for example

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`.local/share/jupyter/jupyter_ai/config.json`, for example
`~/.local/share/jupyter/jupyter_ai/config.json`, for example

Comment thread README.md Outdated
"completions_fields": {}
}
```
The related secret (`OPENAI_API_KEY` in that case) should be stored in a `.env` file at the jupyter lab root:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The related secret (`OPENAI_API_KEY` in that case) should be stored in a `.env` file at the jupyter lab root:
The related secret (`OPENAI_API_KEY` in that case) should be stored in a `.env` file at the jupyter lab root:

@cmarmo

cmarmo commented Aug 19, 2026

Copy link
Copy Markdown
Contributor Author

Should this configuration go in the section Configuration > jupyternaut ?

I've moved it below, keeping a link to the conf section: we briefly talk about configuration here so I like having a reference to all the possible configuration methods.

@brichet brichet added the documentation Improvements or additions to documentation label Aug 19, 2026

@brichet brichet left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @cmarmo

@brichet
brichet merged commit 7b13f14 into QuantStack:main Aug 19, 2026
7 checks passed
@cmarmo
cmarmo deleted the naut-config branch August 19, 2026 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants