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

Document how to add custom model providers #420

Merged
merged 2 commits into from
Oct 30, 2023

Conversation

krassowski
Copy link
Member

@krassowski krassowski commented Oct 29, 2023

References

Relates to issues:

Code changes

  • when loading model via entry points fails, display the error message in the logs
  • fix a typo in a debug log

User-facing changes

Adds a documentation section describing a minimal, two-file custom LLM provider, with links to upstream (LangChain) documentation for further reading.

Demo of the model

demo

@krassowski krassowski added the documentation Improvements or additions to documentation label Oct 29, 2023
@krassowski krassowski marked this pull request as ready for review October 29, 2023 14:47
Copy link
Collaborator

@JasonWeill JasonWeill left a comment

Choose a reason for hiding this comment

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

Thank you so much for improving the docs! A few small changes, otherwise looking good, thanks.

docs/source/users/index.md Outdated Show resolved Hide resolved
docs/source/users/index.md Outdated Show resolved Hide resolved
docs/source/users/index.md Outdated Show resolved Hide resolved
docs/source/users/index.md Outdated Show resolved Hide resolved
docs/source/users/index.md Outdated Show resolved Hide resolved
docs/source/users/index.md Outdated Show resolved Hide resolved
Co-authored-by: Jason Weill <93281816+JasonWeill@users.noreply.github.com>
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.

Awesome, thank you @krassowski!

@dlqqq dlqqq merged commit 7e4a2a5 into jupyterlab:main Oct 30, 2023
6 checks passed
@JasonWeill
Copy link
Collaborator

@meeseeksdev please backport to 1.x

Copy link

lumberbot-app bot commented Nov 8, 2023

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout 1.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 7e4a2a5115ea691afb68522ec267d879e8b3fc95
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #420: Document how to add custom model providers'
  1. Push to a named branch:
git push YOURFORK 1.x:auto-backport-of-pr-420-on-1.x
  1. Create a PR against branch 1.x, I would have named this PR:

"Backport PR #420 on branch 1.x (Document how to add custom model providers)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

JasonWeill pushed a commit to JasonWeill/jupyter-ai that referenced this pull request Nov 8, 2023
* Document how to add custom model providers

* Apply suggestions from review

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

---------

Co-authored-by: Jason Weill <93281816+JasonWeill@users.noreply.github.com>
(cherry picked from commit 7e4a2a5)
dbelgrod pushed a commit to dbelgrod/jupyter-ai that referenced this pull request Jun 10, 2024
* Document how to add custom model providers

* Apply suggestions from review

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

---------

Co-authored-by: Jason Weill <93281816+JasonWeill@users.noreply.github.com>
Marchlak pushed a commit to Marchlak/jupyter-ai that referenced this pull request Oct 28, 2024
* Document how to add custom model providers

* Apply suggestions from review

Co-authored-by: Jason Weill <93281816+JasonWeill@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.

3 participants