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

Updates docs with reset, model lists #254

Merged
merged 14 commits into from
Jul 10, 2023
Merged

Conversation

JasonWeill
Copy link
Collaborator

@JasonWeill JasonWeill commented Jul 6, 2023

Fixes #189 and #198.

Updated docs: https://jupyter-ai--254.org.readthedocs.build/en/254/users/index.html

Updates the documentation to mention the -r and --help options. Updates the documentation and the %ai list command to display help about finding model names for Hugging Face Hub and SageMaker endpoints. See screen shot below.

Corrects spelling of the company's name from HuggingFace (no space) to Hugging Face.

image

@JasonWeill JasonWeill added documentation Improvements or additions to documentation enhancement New feature or request @jupyter-ai/magics labels Jul 6, 2023
@JasonWeill JasonWeill closed this Jul 6, 2023
@JasonWeill JasonWeill reopened this Jul 6, 2023
@JasonWeill
Copy link
Collaborator Author

Updates per @dlqqq's feedback — thanks! Note the new screen shot in the PR description.

packages/jupyter-ai-magics/jupyter_ai_magics/providers.py Outdated Show resolved Hide resolved
docs/source/users/index.md Outdated Show resolved Hide resolved
@3coins
Copy link
Collaborator

3coins commented Jul 8, 2023

@JasonWeill
Thanks for working on this. Would this also cover the help on the input fields in the chat interface?

@JasonWeill
Copy link
Collaborator Author

This PR does not affect the chat UI; it, and the issues it fixes, only concerns the docs and the magic commands.

@JasonWeill
Copy link
Collaborator Author

Updated docs and sample notebook.

Copy link
Member

@dlqqq dlqqq left a comment

Choose a reason for hiding this comment

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

Rebased this branch onto latest main. Looks good!

dbelgrod pushed a commit to dbelgrod/jupyter-ai that referenced this pull request Jun 10, 2024
* Adds clear history documentation

* Explanatory text about HF and SM

* --help param

* HuggingFace -> Hugging Face (as company name)

* Adds provision for provider to have help when no model list exists

* Missing space

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

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

* Renames model_help key to "help"

* Example for HuggingFace

* Additional detail on arguments

* Update packages/jupyter-ai-magics/jupyter_ai_magics/providers.py

Co-authored-by: Piyush Jain <[email protected]>

* Update docs/source/users/index.md

Co-authored-by: Piyush Jain <[email protected]>

* Update packages/jupyter-ai-magics/jupyter_ai_magics/providers.py

Co-authored-by: Piyush Jain <[email protected]>

* Updates sample notebook

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Piyush Jain <[email protected]>
Marchlak pushed a commit to Marchlak/jupyter-ai that referenced this pull request Oct 28, 2024
* Adds clear history documentation

* Explanatory text about HF and SM

* --help param

* HuggingFace -> Hugging Face (as company name)

* Adds provision for provider to have help when no model list exists

* Missing space

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

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

* Renames model_help key to "help"

* Example for HuggingFace

* Additional detail on arguments

* Update packages/jupyter-ai-magics/jupyter_ai_magics/providers.py

Co-authored-by: Piyush Jain <[email protected]>

* Update docs/source/users/index.md

Co-authored-by: Piyush Jain <[email protected]>

* Update packages/jupyter-ai-magics/jupyter_ai_magics/providers.py

Co-authored-by: Piyush Jain <[email protected]>

* Updates sample notebook

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Piyush Jain <[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 enhancement New feature or request @jupyter-ai/magics
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document -r option in magic commands
3 participants