-
Notifications
You must be signed in to change notification settings - Fork 15.1k
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
Standardize LLM Docs #24803
Labels
🤖:docs
Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
help wanted
Good issue for contributors
integration-docs
Comments
dosubot
bot
added
the
🤖:docs
Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
label
Jul 30, 2024
ccurme
pushed a commit
that referenced
this issue
Aug 6, 2024
ccurme
pushed a commit
that referenced
this issue
Aug 7, 2024
This was referenced Aug 9, 2024
Merged
ccurme
added a commit
that referenced
this issue
Aug 11, 2024
- **Description:** Standardize OpenAI Docs - **Issue:** the issue #24803 --------- Co-authored-by: Chester Curme <chester.curme@gmail.com>
ccurme
pushed a commit
that referenced
this issue
Aug 13, 2024
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
- **Description:** Standardize Tongyi LLM,include: - docs, the issue langchain-ai#24803 - model init arg names, the issue langchain-ai#20085
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
- **Description:** Standardize QianfanLLMEndpoint LLM,include: - docs, the issue langchain-ai#24803 - model init arg names, the issue langchain-ai#20085
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
- **Description:** Standardize OpenAI Docs - **Issue:** the issue langchain-ai#24803 --------- Co-authored-by: Chester Curme <chester.curme@gmail.com>
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
- **Description:** Standardize SparkLLM, include: - docs, the issue langchain-ai#24803 - to support stream - update api url - model init arg names, the issue langchain-ai#20085
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
🤖:docs
Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
help wanted
Good issue for contributors
integration-docs
Privileged issue
Issue Content
Issue
To make our LLM integrations as easy to use as possible we need to make sure the docs for them are thorough and standardized. There are two parts to this: updating the llm docstrings and updating the actual integration docs.
This needs to be done for each LLM integration, ideally with one PR per LLM.
Related to broader issues #21983 and #22005.
Docstrings
Each LLM class docstring should have the sections shown in the Appendix below. The sections should have input and output code blocks when relevant.
To build a preview of the API docs for the package you're working on run (from root of repo):
make api_docs_clean; make api_docs_quick_preview API_PKG=openai
where
API_PKG=
should be the parent directory that houses the edited package (e.g. community, openai, anthropic, huggingface, together, mistralai, groq, fireworks, etc.). This should be quite fast for all the partner packages.Doc pages
Each LLM docs page should follow this template.
You can use the
langchain-cli
to quickly get started with a new chat model integration docs page (run from root of repo):poetry run pip install -e libs/cli poetry run langchain-cli integration create-doc --name "foo-bar" --name-class FooBar --component-type LLM --destination-dir ./docs/docs/integrations/llms/
where
--name
is the integration package name without the "langchain-" prefix and--name-class
is the class name without the "LLM" prefix. This will create a template doc with some autopopulated fields at docs/docs/integrations/llms/foo_bar.ipynb.To build a preview of the docs you can run (from root):
make docs_clean make docs_build cd docs/build/output-new yarn yarn start
Appendix
Expected sections for the LLM class docstring.
The text was updated successfully, but these errors were encountered: