-
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 Embeddings Docs #24856
Labels
🤖:docs
Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
Ɑ: embeddings
Related to text embedding models module
help wanted
Good issue for contributors
integration-docs
Comments
dosubot
bot
added
Ɑ: embeddings
Related to text embedding models module
🤖:docs
Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
labels
Jul 31, 2024
running
am I missing anything? |
Try updating your cli with poetry run pip install -U langchain-cli |
ccurme
pushed a commit
that referenced
this issue
Aug 1, 2024
- **Description:** Standardize ZhipuAIEmbeddings rich docstrings. - **Issue:** the issue #24856
This was referenced Aug 2, 2024
ccurme
pushed a commit
that referenced
this issue
Aug 3, 2024
- **Description:** Standardize SparkLLMTextEmbeddings docstrings - **Issue:** the issue #24856
ccurme
pushed a commit
that referenced
this issue
Aug 3, 2024
This was referenced Aug 9, 2024
eyurtsev
added a commit
that referenced
this issue
Aug 12, 2024
This was referenced Aug 12, 2024
This was referenced Aug 12, 2024
eyurtsev
added a commit
that referenced
this issue
Aug 12, 2024
eyurtsev
added a commit
that referenced
this issue
Aug 12, 2024
Add API Reference documentation for the FireworksEmbedding model. Issue: #24856
eyurtsev
added a commit
that referenced
this issue
Aug 12, 2024
eyurtsev
added a commit
that referenced
this issue
Aug 13, 2024
Update API reference for OllamaEmbeddings Issue: #24856
isahers1
added a commit
that referenced
this issue
Aug 14, 2024
Providers: * fireworks See related issue: * #24856 Features: ```json [ { "provider": "fireworks", "js": true, "local": false, "serializable": false, } ] ``` --------- Co-authored-by: isaac hershenson <ihershenson@hmc.edu> Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com>
isahers1
added a commit
that referenced
this issue
Aug 14, 2024
Related issue: #24856 ```json { "provider": "openai", "js": true, "local": false, "serializable": false, "async_native": true } ``` --------- Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
isahers1
added a commit
that referenced
this issue
Aug 14, 2024
Issue: #24856 --------- Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
isahers1
added a commit
that referenced
this issue
Aug 14, 2024
Update together AI embedding integration docs Related issue: #24856 ```json [ { "provider": "together", "js": true, "local": false, "serializable": false, } ] ``` --------- Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
isahers1
added a commit
that referenced
this issue
Aug 14, 2024
Related issue: #24856 ```json [ { "provider": "mistralai", "js": true, "local": false, "serializable": false, "native_async": true } ] ``` --------- Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
isahers1
added a commit
that referenced
this issue
Aug 14, 2024
Update AI21 Integration docs Issue: #24856 --------- Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
isahers1
added a commit
that referenced
this issue
Aug 14, 2024
Issue: #24856 --------- Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
isahers1
added a commit
that referenced
this issue
Aug 14, 2024
#24856 --------- Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
isahers1
added a commit
that referenced
this issue
Aug 14, 2024
This can be finished after the following issue is resolved: langchain-ai/langchain-cohere#81 Related to: #24856 ```json [ { "provider": "cohere", "js": true, "local": false, "serializable": false, } ] ``` --------- Co-authored-by: isaac hershenson <ihershenson@hmc.edu> Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com>
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
- **Description:** Standardize ZhipuAIEmbeddings rich docstrings. - **Issue:** the issue langchain-ai#24856
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
- **Description:** Standardize SparkLLMTextEmbeddings docstrings - **Issue:** the issue langchain-ai#24856
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
- **Description:** Standardize MiniMaxEmbeddings - docs, the issue langchain-ai#24856 - model init arg names, the issue langchain-ai#20085
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
…angchain-ai#25294) Update API Reference for MistralAI embeddings Issue: langchain-ai#24856
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
…ain-ai#25292) Add API Reference documentation for the FireworksEmbedding model. Issue: langchain-ai#24856
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
…5313) Issue: langchain-ai#24856 Using the same template for the fake embeddings in langchain_core as used in the integrations.
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
…ai#25315) Update API reference for OllamaEmbeddings Issue: langchain-ai#24856
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
…i#25247) Providers: * fireworks See related issue: * langchain-ai#24856 Features: ```json [ { "provider": "fireworks", "js": true, "local": false, "serializable": false, } ] ``` --------- Co-authored-by: isaac hershenson <ihershenson@hmc.edu> Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com>
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
Related issue: langchain-ai#24856 ```json { "provider": "openai", "js": true, "local": false, "serializable": false, "async_native": true } ``` --------- Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
…#25314) Issue: langchain-ai#24856 --------- Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
Update together AI embedding integration docs Related issue: langchain-ai#24856 ```json [ { "provider": "together", "js": true, "local": false, "serializable": false, } ] ``` --------- Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
…in-ai#25253) Related issue: langchain-ai#24856 ```json [ { "provider": "mistralai", "js": true, "local": false, "serializable": false, "native_async": true } ] ``` --------- Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
Update AI21 Integration docs Issue: langchain-ai#24856 --------- Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
Issue: langchain-ai#24856 --------- Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
…hain-ai#25311) langchain-ai#24856 --------- Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
olgamurraft
pushed a commit
to olgamurraft/langchain
that referenced
this issue
Aug 16, 2024
…25250) This can be finished after the following issue is resolved: langchain-ai/langchain-cohere#81 Related to: langchain-ai#24856 ```json [ { "provider": "cohere", "js": true, "local": false, "serializable": false, } ] ``` --------- Co-authored-by: isaac hershenson <ihershenson@hmc.edu> Co-authored-by: Isaac Francisco <78627776+isahers1@users.noreply.github.com>
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
Ɑ: embeddings
Related to text embedding models module
help wanted
Good issue for contributors
integration-docs
Privileged issue
Issue Content
Issue
To make our Embeddings 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 embeddings docstrings and updating the actual integration docs.
This needs to be done for each embeddings integration, ideally with one PR per embedding provider.
Related to broader issues #21983 and #22005.
Docstrings
Each Embeddings 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 Embeddings 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 Embeddings --destination-dir ./docs/docs/integrations/text_embedding/
where
--name
is the integration package name without the "langchain-" prefix and--name-class
is the class name without the "Embedding" prefix. This will create a template doc with some autopopulated fields at docs/docs/integrations/text_embedding/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 Embedding class docstring.
__package_name___
: This is the full name of the package (e.g.,langchain-anthropic
)__ModuleName__
: This is the CamelCase name of the partner (e.g.,Anthropic
)__MODULE_NAME__
: SCREAMING_SNAKE_CASE name of the partner (e.g., ANTHROPIC)Y
Tip: if you copy and paste the template to a template.txt file, you could use the following sed commands to fill in the appropriate values for OpenAI:
The text was updated successfully, but these errors were encountered: