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

Improve user messaging and documentation for Cross-Region Inference on Amazon Bedrock #1134

Merged
merged 16 commits into from
Dec 6, 2024

Conversation

srdas
Copy link
Collaborator

@srdas srdas commented Dec 3, 2024

Fixes #1121

Amazon Cross Region Inference is implemented by prefixing a region code to the base model id. Given the growing number of regions and models, adding each specific one to the drop down model list is cumbersome. Instead, the user can simple handle cross-region inference through Jupyter AI's custom/provisioned model interface for Bedrock that has been updated to indicate this, as shown below:
image
Here the US specific region model id is used.
The related documentation has also been updated to reflect these changes.

@srdas srdas added the documentation Improvements or additions to documentation label Dec 3, 2024
@srdas srdas marked this pull request as ready for review December 3, 2024 09:24
@srdas srdas requested a review from dlqqq December 3, 2024 09:25
docs/source/users/index.md Outdated Show resolved Hide resolved
@srdas srdas requested a review from dlqqq December 5, 2024 19:48
@dlqqq dlqqq changed the title Updated UI and documentation for Amazon Bedrock Cross Region Inference Improve user messaging and documentation for Cross-Region Inference on Amazon Bedrock Dec 6, 2024
docs/source/users/index.md Outdated Show resolved Hide resolved
@srdas srdas requested a review from dlqqq December 6, 2024 22:05
@dlqqq dlqqq merged commit 5ffe481 into jupyterlab:main Dec 6, 2024
10 checks passed
@dlqqq
Copy link
Member

dlqqq commented Dec 6, 2024

@meeseeksdev please backport to v3-dev

meeseeksmachine pushed a commit to meeseeksmachine/jupyter-ai that referenced this pull request Dec 6, 2024
… for Cross-Region Inference on Amazon Bedrock
dlqqq pushed a commit that referenced this pull request Dec 6, 2024
…-Region Inference on Amazon Bedrock (#1143)

Co-authored-by: Sanjiv Das <[email protected]>
dlqqq added a commit that referenced this pull request Dec 26, 2024
* Backport PR #1049: Added new Anthropic Sonnet3.5 v2 models (#1050)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR #1051: Added Developer documentation for streaming responses (#1058)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR #1048: Implement streaming for `/fix` (#1059)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR #1057: [pre-commit.ci] pre-commit autoupdate (#1060)

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

* Backport PR #1064: Added Ollama to the providers table in user docs (#1066)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR #1056: Add examples of using Fields and EnvAuthStrategy to developer documentation (#1073)

Co-authored-by: Alan Meeson <[email protected]>

* Backport PR #1069: Merge Anthropic language model providers (#1076)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR #1068: Allow `$` to literally denote quantities of USD in chat (#1079)

Co-authored-by: david qiu <[email protected]>

* Backport PR #1075: Fix magic commands when using non-chat providers w/ history (#1080)

Co-authored-by: Alan Meeson <[email protected]>

* Backport PR #1077: Fix `/export` by including streamed agent messages (#1081)

Co-authored-by: Mahmut CAVDAR <[email protected]>

* Backport PR #1072: Reduced padding in cell around code icons in code toolbar (#1084)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR #1087: Improve installation documentation and clarify provider dependencies (#1091)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR #1092: Remove retired models and add new `Haiku-3.5` model in Anthropic (#1093)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR #1094: Continue to allow `$` symbols to delimit inline math in human messages (#1095)

Co-authored-by: david qiu <[email protected]>

* Backport PR #1097: Update `faiss-cpu` version range (#1101)

Co-authored-by: david qiu <[email protected]>

* Backport PR #1104: Fix rendering of code blocks in JupyterLab 4.3.0+ (#1105)

Co-authored-by: david qiu <[email protected]>

* Backport PR #1106: Catch error on non plaintext files in `@file` and reply gracefully in chat (#1110)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR #1109: Bump LangChain minimum versions (#1112)

Co-authored-by: david qiu <[email protected]>

* Backport PR #1119: Downgrade spurious 'error' logs (#1124)

Co-authored-by: ctcjab <[email protected]>

* Backport PR #1127: Removes outdated OpenAI models and adds new ones (#1130)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR #1131: [pre-commit.ci] pre-commit autoupdate (#1132)

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

* Backport PR #1125: Update model fields immediately on save (#1133)

Co-authored-by: david qiu <[email protected]>

* Backport PR #1139: Fix install step in CI (#1140)

Co-authored-by: david qiu <[email protected]>

* Backport PR #1129: Fix JSON serialization error in Ollama models (#1141)

Co-authored-by: Mr.W <[email protected]>

* Backport PR #1137: Update completion model fields immediately on save (#1142)

Co-authored-by: david qiu <[email protected]>

* [v3-dev] Initial migration to `jupyterlab-chat` (#1043)

* Very first version of the AI working in jupyterlab_collaborative_chat

* Allows both collaborative and regular chat to work with AI

* handle the help message in the chat too

* Autocompletion (#2)

* Fix handler methods' parameters

* Add slash commands (autocompletion) to the chat input

* Stream messages (#3)

* Allow for stream messages

* update jupyter collaborative chat dependency

* AI settings (#4)

* Add a menu option to open the AI settings

* Remove the input option from the setting widget

* pre-commit

* linting

* Homogeneize typing for optional arguments

* Fix import

* Showing that the bot is writing (answering) (#5)

* Show that the bot is writing (answering)

* Update jupyter chat dependency

* Some typing

* Update extension to jupyterlab_chat (0.6.0) (#8)

* Fix linting

* Remove try/except to import jupyterlab_chat (not optional anymore), and fix typing

* linter

* Python unit tests

* Fix typing

* lint

* Fix lint and mypy all together

* Fix web_app settings accessor

* Fix jupyter_collaboration version

Co-authored-by: david qiu <[email protected]>

* Remove unecessary try/except

* Dedicate one set of chat handlers per room (#9)

* create new set of chat handlers per room

* make YChat an instance attribute on BaseChatHandler

* revert changes to chat handlers

* pre-commit

* use room_id local var

Co-authored-by: Nicolas Brichet <[email protected]>

---------

Co-authored-by: Nicolas Brichet <[email protected]>

---------

Co-authored-by: david qiu <[email protected]>
Co-authored-by: david qiu <[email protected]>

* Backport PR #1134: Improve user messaging and documentation for Cross-Region Inference on Amazon Bedrock (#1143)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR #1136: Add base API URL field for Ollama and OpenAI embedding models (#1149)

Co-authored-by: Sanjiv Das <[email protected]>

* [v3-dev] Remove `/export`, `/clear`, and `/fix` (#1148)

* remove /export

* remove /clear

* remove /fix

* Fix CI in `v3-dev` branch (#1154)

* fix check release by bumping to impossible version

* fix types

* Update Playwright Snapshots

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* [v3-dev] Dedicate one LangChain history object per chat (#1151)

* dedicate a separate LangChain history object per chat

* pre-commit

* fix mypy

* Backport PR #1160: Trigger update snapshots based on commenter's role (#1161)

Co-authored-by: david qiu <[email protected]>

* Backport PR #1155: Fix code output format in IPython (#1162)

Co-authored-by: Divyansh Choudhary <[email protected]>

* Backport PR #1158: Update `/generate` to not split classes & functions across cells (#1164)

Co-authored-by: Sanjiv Das <[email protected]>

* Remove v2 frontend components (#1156)

* First pass to remove the front end chat

* Remove code-toolbar by using a simplified markdown renderer in settings

* Remove chat-message-menu (should be ported in jupyter-chat)

* Remove chat handler

* Follow up 'Remove chat-message-menu (should be ported in jupyter-chat)' commit

* Clean package.json

* Remove UI tests

* Remove the generative AI menu

* Remove unused components

* run yarn dedupe

---------

Co-authored-by: David L. Qiu <[email protected]>

* Upgrade to `jupyterlab-chat>=0.7.0` (#1166)

* upgrade to jupyterlab-chat 0.7.0

* pre-commit

* upgrade to @jupyter/chat ^0.7.0 in frontend

* Remove v2 backend components (#1168)

* remove v2 llm memory, implement ReplyStream

* remove v2 websockets & REST handlers

* remove unused v2 data models

* fix slash command autocomplete

* fix unit tests

* remove unused _learned context provider

* fix mypy

* pre-commit

* fix optional k arg in YChatHistory

* bump jupyter chat to 0.7.1 to fix Python 3.9 tests

* revert accidentally breaking /learn

---------

Co-authored-by: Lumberbot (aka Jack) <[email protected]>
Co-authored-by: Sanjiv Das <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Alan Meeson <[email protected]>
Co-authored-by: Mahmut CAVDAR <[email protected]>
Co-authored-by: ctcjab <[email protected]>
Co-authored-by: Mr.W <[email protected]>
Co-authored-by: Nicolas Brichet <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Divyansh Choudhary <[email protected]>
srdas added a commit to srdas/jupyter-ai that referenced this pull request Jan 6, 2025
…n Amazon Bedrock (jupyterlab#1134)

* Updated UI and documentation for Amazon Bedrock Cross Region Inference

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

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

* screenshot for CRI usage

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

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

* Consolidated Bedrock chat documentation

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

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

* Update bedrock.md

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

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

* Update install.sh

* Update install.sh

* Fix install step in CI (jupyterlab#1139)

* fix install in CI

* pre-commit

* Update docs/source/users/index.md

Co-authored-by: david qiu <[email protected]>

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: david qiu <[email protected]>
srdas added a commit to srdas/jupyter-ai that referenced this pull request Jan 6, 2025
* Backport PR jupyterlab#1049: Added new Anthropic Sonnet3.5 v2 models (jupyterlab#1050)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR jupyterlab#1051: Added Developer documentation for streaming responses (jupyterlab#1058)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR jupyterlab#1048: Implement streaming for `/fix` (jupyterlab#1059)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR jupyterlab#1057: [pre-commit.ci] pre-commit autoupdate (jupyterlab#1060)

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

* Backport PR jupyterlab#1064: Added Ollama to the providers table in user docs (jupyterlab#1066)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR jupyterlab#1056: Add examples of using Fields and EnvAuthStrategy to developer documentation (jupyterlab#1073)

Co-authored-by: Alan Meeson <[email protected]>

* Backport PR jupyterlab#1069: Merge Anthropic language model providers (jupyterlab#1076)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR jupyterlab#1068: Allow `$` to literally denote quantities of USD in chat (jupyterlab#1079)

Co-authored-by: david qiu <[email protected]>

* Backport PR jupyterlab#1075: Fix magic commands when using non-chat providers w/ history (jupyterlab#1080)

Co-authored-by: Alan Meeson <[email protected]>

* Backport PR jupyterlab#1077: Fix `/export` by including streamed agent messages (jupyterlab#1081)

Co-authored-by: Mahmut CAVDAR <[email protected]>

* Backport PR jupyterlab#1072: Reduced padding in cell around code icons in code toolbar (jupyterlab#1084)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR jupyterlab#1087: Improve installation documentation and clarify provider dependencies (jupyterlab#1091)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR jupyterlab#1092: Remove retired models and add new `Haiku-3.5` model in Anthropic (jupyterlab#1093)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR jupyterlab#1094: Continue to allow `$` symbols to delimit inline math in human messages (jupyterlab#1095)

Co-authored-by: david qiu <[email protected]>

* Backport PR jupyterlab#1097: Update `faiss-cpu` version range (jupyterlab#1101)

Co-authored-by: david qiu <[email protected]>

* Backport PR jupyterlab#1104: Fix rendering of code blocks in JupyterLab 4.3.0+ (jupyterlab#1105)

Co-authored-by: david qiu <[email protected]>

* Backport PR jupyterlab#1106: Catch error on non plaintext files in `@file` and reply gracefully in chat (jupyterlab#1110)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR jupyterlab#1109: Bump LangChain minimum versions (jupyterlab#1112)

Co-authored-by: david qiu <[email protected]>

* Backport PR jupyterlab#1119: Downgrade spurious 'error' logs (jupyterlab#1124)

Co-authored-by: ctcjab <[email protected]>

* Backport PR jupyterlab#1127: Removes outdated OpenAI models and adds new ones (jupyterlab#1130)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR jupyterlab#1131: [pre-commit.ci] pre-commit autoupdate (jupyterlab#1132)

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

* Backport PR jupyterlab#1125: Update model fields immediately on save (jupyterlab#1133)

Co-authored-by: david qiu <[email protected]>

* Backport PR jupyterlab#1139: Fix install step in CI (jupyterlab#1140)

Co-authored-by: david qiu <[email protected]>

* Backport PR jupyterlab#1129: Fix JSON serialization error in Ollama models (jupyterlab#1141)

Co-authored-by: Mr.W <[email protected]>

* Backport PR jupyterlab#1137: Update completion model fields immediately on save (jupyterlab#1142)

Co-authored-by: david qiu <[email protected]>

* [v3-dev] Initial migration to `jupyterlab-chat` (jupyterlab#1043)

* Very first version of the AI working in jupyterlab_collaborative_chat

* Allows both collaborative and regular chat to work with AI

* handle the help message in the chat too

* Autocompletion (jupyterlab#2)

* Fix handler methods' parameters

* Add slash commands (autocompletion) to the chat input

* Stream messages (jupyterlab#3)

* Allow for stream messages

* update jupyter collaborative chat dependency

* AI settings (jupyterlab#4)

* Add a menu option to open the AI settings

* Remove the input option from the setting widget

* pre-commit

* linting

* Homogeneize typing for optional arguments

* Fix import

* Showing that the bot is writing (answering) (jupyterlab#5)

* Show that the bot is writing (answering)

* Update jupyter chat dependency

* Some typing

* Update extension to jupyterlab_chat (0.6.0) (jupyterlab#8)

* Fix linting

* Remove try/except to import jupyterlab_chat (not optional anymore), and fix typing

* linter

* Python unit tests

* Fix typing

* lint

* Fix lint and mypy all together

* Fix web_app settings accessor

* Fix jupyter_collaboration version

Co-authored-by: david qiu <[email protected]>

* Remove unecessary try/except

* Dedicate one set of chat handlers per room (jupyterlab#9)

* create new set of chat handlers per room

* make YChat an instance attribute on BaseChatHandler

* revert changes to chat handlers

* pre-commit

* use room_id local var

Co-authored-by: Nicolas Brichet <[email protected]>

---------

Co-authored-by: Nicolas Brichet <[email protected]>

---------

Co-authored-by: david qiu <[email protected]>
Co-authored-by: david qiu <[email protected]>

* Backport PR jupyterlab#1134: Improve user messaging and documentation for Cross-Region Inference on Amazon Bedrock (jupyterlab#1143)

Co-authored-by: Sanjiv Das <[email protected]>

* Backport PR jupyterlab#1136: Add base API URL field for Ollama and OpenAI embedding models (jupyterlab#1149)

Co-authored-by: Sanjiv Das <[email protected]>

* [v3-dev] Remove `/export`, `/clear`, and `/fix` (jupyterlab#1148)

* remove /export

* remove /clear

* remove /fix

* Fix CI in `v3-dev` branch (jupyterlab#1154)

* fix check release by bumping to impossible version

* fix types

* Update Playwright Snapshots

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* [v3-dev] Dedicate one LangChain history object per chat (jupyterlab#1151)

* dedicate a separate LangChain history object per chat

* pre-commit

* fix mypy

* Backport PR jupyterlab#1160: Trigger update snapshots based on commenter's role (jupyterlab#1161)

Co-authored-by: david qiu <[email protected]>

* Backport PR jupyterlab#1155: Fix code output format in IPython (jupyterlab#1162)

Co-authored-by: Divyansh Choudhary <[email protected]>

* Backport PR jupyterlab#1158: Update `/generate` to not split classes & functions across cells (jupyterlab#1164)

Co-authored-by: Sanjiv Das <[email protected]>

* Remove v2 frontend components (jupyterlab#1156)

* First pass to remove the front end chat

* Remove code-toolbar by using a simplified markdown renderer in settings

* Remove chat-message-menu (should be ported in jupyter-chat)

* Remove chat handler

* Follow up 'Remove chat-message-menu (should be ported in jupyter-chat)' commit

* Clean package.json

* Remove UI tests

* Remove the generative AI menu

* Remove unused components

* run yarn dedupe

---------

Co-authored-by: David L. Qiu <[email protected]>

* Upgrade to `jupyterlab-chat>=0.7.0` (jupyterlab#1166)

* upgrade to jupyterlab-chat 0.7.0

* pre-commit

* upgrade to @jupyter/chat ^0.7.0 in frontend

* Remove v2 backend components (jupyterlab#1168)

* remove v2 llm memory, implement ReplyStream

* remove v2 websockets & REST handlers

* remove unused v2 data models

* fix slash command autocomplete

* fix unit tests

* remove unused _learned context provider

* fix mypy

* pre-commit

* fix optional k arg in YChatHistory

* bump jupyter chat to 0.7.1 to fix Python 3.9 tests

* revert accidentally breaking /learn

---------

Co-authored-by: Lumberbot (aka Jack) <[email protected]>
Co-authored-by: Sanjiv Das <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Alan Meeson <[email protected]>
Co-authored-by: Mahmut CAVDAR <[email protected]>
Co-authored-by: ctcjab <[email protected]>
Co-authored-by: Mr.W <[email protected]>
Co-authored-by: Nicolas Brichet <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Divyansh Choudhary <[email protected]>
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.

Document how to use CRI on Amazon Bedrock in Jupyter AI v2
2 participants