Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Users section of the docs #494

Merged
merged 12 commits into from
Dec 4, 2023

Conversation

andrii-i
Copy link
Collaborator

@andrii-i andrii-i commented Nov 30, 2023

Problem

  1. Currently "Model providers" section of the user docs (https://jupyter-ai.readthedocs.io/en/latest/users/index.html#model-providers) shows an example of setting an API key as env variable. But that will only work for the magics providers. To set API keys for chat interface, users need to use chat settings UI or config.json.

Note that users are getting introduced to %ai magic commands in "The %ai and %%ai magic commands" section of the docs (https://jupyter-ai.readthedocs.io/en/latest/users/index.html#the-ai-and-ai-magic-commands) which is located much further down the page.

image

  1. The chat interface section of the user docs has screenshots of previous version of chat settings UI https://jupyter-ai.readthedocs.io/en/latest/users/index.html#the-chat-interface

image

  1. Currently user docs have “Custom model providers” and “Customizing prompt templates” sub-subsections that explain how to customize J-AI with code before “The chat interface” subsection that explains how to use J-AI's interface.
image

All three might be confusing for new users not familiar with Jupyter-AI and make onboarding experience hard(er).

Proposed Solution

  1. Update "Model providers" section of the docs replacing use of env variable in the example with a use of chat settings UI or config.json.
  2. Update chat settings screenshots
  3. Promote “Custom model providers” and “Customizing prompt templates” sub-subsections to sub-sections, move them to the bottom of the users doc page, below “The chat interface” and “Configuration” sub-sections section. Now table of content would look like:
image

@andrii-i andrii-i added the documentation Improvements or additions to documentation label Nov 30, 2023
@andrii-i andrii-i changed the title Update example of setting model provider and API key in the user documentation Update example of setting API keys, chat settings screenshots in the user documentation Nov 30, 2023
@andrii-i andrii-i changed the title Update example of setting API keys, chat settings screenshots in the user documentation Update example of setting API keys, update chat settings screenshots in the user documentation Nov 30, 2023
@andrii-i andrii-i changed the title Update example of setting API keys, update chat settings screenshots in the user documentation Update Users section of the docs Nov 30, 2023
Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>
docs/source/users/index.md Outdated Show resolved Hide resolved
andrii-i and others added 2 commits November 30, 2023 14:16
Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>
@andrii-i
Copy link
Collaborator Author

andrii-i commented Dec 1, 2023

@JasonWeill @3coins @krassowski thank you very much for looking into this PR. All comments were addressed, please give it a look again when possible.

docs/source/developers/index.md Outdated Show resolved Hide resolved
docs/source/users/index.md Outdated Show resolved Hide resolved
andrii-i and others added 2 commits December 4, 2023 09:16
Co-authored-by: Jason Weill <93281816+JasonWeill@users.noreply.github.com>
variable when you start JupyterLab from a terminal:
For example, to use OpenAI models, use the chat interface settings panel to choose the OpenAI language model:

<img src="../_static/chat-settings-choose-language-model.png"
Copy link
Collaborator

Choose a reason for hiding this comment

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

The screen shot doesn't show any OpenAI language models. While we as users know that we can scroll down to pick an OpenAI model, in the docs, it might be better to show a screen shot with an OpenAI model visible.

Alternatively, you can change the text above to say, "For example, to use AI21 models, …"

Copy link
Collaborator

@3coins 3coins left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for making all the updates.

@andrii-i
Copy link
Collaborator Author

andrii-i commented Dec 4, 2023

Thank you for looking into this everyone.

@andrii-i andrii-i merged commit 9c69a7b into jupyterlab:main Dec 4, 2023
5 of 6 checks passed
@andrii-i andrii-i deleted the docs_setting_env_variable branch December 4, 2023 19:26
dlqqq pushed a commit to dlqqq/jupyter-ai that referenced this pull request Dec 8, 2023
* Update example of setting model provider and API key

* resize screenshots

* update chat settings screenshots

* Promote “Custom model providers” and “Customizing prompt templates” to subsections, move them to the bottom of the users doc page

* Update docs/source/users/index.md

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>

* Update docs/source/users/index.md

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>

* change double-backtick to single-backticks as they serve the same function

* move  Prompt templates sections to Developers page

* Update snapshots to use the same zoom level

* Update docs/source/developers/index.md

Co-authored-by: Jason Weill <93281816+JasonWeill@users.noreply.github.com>

* move "Custom model providers" section to Dev page

* Update lang model choice screen to show OpenAI models mentioned in text around the screenshot

---------

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>
Co-authored-by: Jason Weill <93281816+JasonWeill@users.noreply.github.com>
dlqqq added a commit that referenced this pull request Dec 8, 2023
* Update Users section of the docs (#494)

* Update example of setting model provider and API key

* resize screenshots

* update chat settings screenshots

* Promote “Custom model providers” and “Customizing prompt templates” to subsections, move them to the bottom of the users doc page

* Update docs/source/users/index.md

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>

* Update docs/source/users/index.md

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>

* change double-backtick to single-backticks as they serve the same function

* move  Prompt templates sections to Developers page

* Update snapshots to use the same zoom level

* Update docs/source/developers/index.md

Co-authored-by: Jason Weill <93281816+JasonWeill@users.noreply.github.com>

* move "Custom model providers" section to Dev page

* Update lang model choice screen to show OpenAI models mentioned in text around the screenshot

---------

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>
Co-authored-by: Jason Weill <93281816+JasonWeill@users.noreply.github.com>

* remove config.json-related information (#503)

* Base chat handler refactor for custom slash commands (#398)

* Adds attributes, starts adding to subclasses

* Consistent syntax

* Help for all handlers

* Fix slash ID error

* Iterate through entry points

* Fix typo in call to select()

* Moves config to magics, modifies extensions to attempt to load classes

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Moves config to proper location, improves error logging

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* WIP: Updates per feedback, adds custom handler

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Removes redundant code, style fixes

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Removes unnecessary custom message

* Instantiates class

* Validates slash ID

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Consistent arguments to chat handlers

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Refactors to avoid intentionally unused params

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Updates docs, removes custom handler from source and config

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Renames process_message to match base class

* Adds needed parameter that had been deleted

* Joins lines in contributor doc

* Removes natural language routing type, which is not yet used

* Update docs/source/developers/index.md

Co-authored-by: Piyush Jain <piyushjain@duck.com>

* Update docs/source/developers/index.md

Co-authored-by: Piyush Jain <piyushjain@duck.com>

* Update docs/source/developers/index.md

Co-authored-by: Piyush Jain <piyushjain@duck.com>

* Revises per @3coins, avoids Latinism

* Removes Configurable, since we do not yet have configurable traits

* Uses Literal for validation

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Piyush Jain <piyushjain@duck.com>

---------

Co-authored-by: Andrii Ieroshenko <aieroshe@amazon.com>
Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>
Co-authored-by: Jason Weill <93281816+JasonWeill@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Piyush Jain <piyushjain@duck.com>
dbelgrod pushed a commit to dbelgrod/jupyter-ai that referenced this pull request Jun 10, 2024
* Update example of setting model provider and API key

* resize screenshots

* update chat settings screenshots

* Promote “Custom model providers” and “Customizing prompt templates” to subsections, move them to the bottom of the users doc page

* Update docs/source/users/index.md

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>

* Update docs/source/users/index.md

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>

* change double-backtick to single-backticks as they serve the same function

* move  Prompt templates sections to Developers page

* Update snapshots to use the same zoom level

* Update docs/source/developers/index.md

Co-authored-by: Jason Weill <93281816+JasonWeill@users.noreply.github.com>

* move "Custom model providers" section to Dev page

* Update lang model choice screen to show OpenAI models mentioned in text around the screenshot

---------

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>
Co-authored-by: Jason Weill <93281816+JasonWeill@users.noreply.github.com>
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.

4 participants