mirror of
https://github.com/hwchase17/langchain
synced 2024-11-11 19:11:02 +00:00
86698b02a9
### Issue: #22299 ### descriptions The documentation appears to be wrong. When the user actually sets this parameter "asynchronous" to be True, it fails because the __init__ function of FAISS class doesn't allow this parameter. In fact, most of the class/instance functions of this class have both the sync/async version, so it looks like what we need is just to remove this parameter from the doc. Thank you for contributing to LangChain! - [x] **PR title**: "package: description" - Where "package" is whichever of langchain, community, core, experimental, etc. is being modified. Use "docs: ..." for purely docs changes, "templates: ..." for template changes, "infra: ..." for CI changes. - Example: "community: add foobar LLM" - [x] **PR message**: ***Delete this entire checklist*** and replace with - **Description:** a description of the change - **Issue:** the issue # it fixes, if applicable - **Dependencies:** any dependencies required for this change - **Twitter handle:** if your PR gets announced, and you'd like a mention, we'll gladly shout you out! - [ ] **Add tests and docs**: If you're adding a new integration, please include 1. a test for the integration, preferably unit tests that do not rely on network access, 2. an example notebook showing its use. It lives in `docs/docs/integrations` directory. - [ ] **Lint and test**: Run `make format`, `make lint` and `make test` from the root of the package(s) you've modified. See contribution guidelines for more: https://python.langchain.com/docs/contributing/ Additional guidelines: - Make sure optional dependencies are imported within a function. - Please do not add dependencies to pyproject.toml files (even optional ones) unless they are required for unit tests. - Most PRs should not touch more than one package. - Changes should be backwards compatible. - If you are adding something to community, do not re-import it in langchain. If no one reviews your PR within a few days, please @-mention one of baskaryan, efriis, eyurtsev, ccurme, vbarda, hwchase17. Co-authored-by: Lifu Wu <lifu@nextbillion.ai> |
||
|---|---|---|
| .. | ||
| adapters | ||
| agent_toolkits | ||
| agents | ||
| callbacks | ||
| chains | ||
| chat_loaders | ||
| chat_message_histories | ||
| chat_models | ||
| cross_encoders | ||
| docstore | ||
| document_compressors | ||
| document_loaders | ||
| document_transformers | ||
| embeddings | ||
| example_selectors | ||
| graphs | ||
| indexes | ||
| llms | ||
| memory | ||
| output_parsers | ||
| query_constructors | ||
| retrievers | ||
| storage | ||
| tools | ||
| utilities | ||
| utils | ||
| vectorstores | ||
| __init__.py | ||
| cache.py | ||
| py.typed | ||