mirror of
https://github.com/hwchase17/langchain.git
synced 2026-06-09 10:17:00 +00:00
chore: update README.md files (#33919)
This commit is contained in:
@@ -34,7 +34,7 @@ The LangChain ecosystem is built on top of `langchain-core`. Some of the benefit
|
|||||||
|
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
For full documentation, see the [API reference](https://reference.langchain.com/python/langchain_core/).
|
For full documentation, see the [API reference](https://reference.langchain.com/python/langchain_core/). For conceptual guides, tutorials, and examples on using LangChain, see the [LangChain Docs](https://docs.langchain.com/oss/python/langchain/overview).
|
||||||
|
|
||||||
## 📕 Releases & Versioning
|
## 📕 Releases & Versioning
|
||||||
|
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ In most cases, you should be using the main [`langchain`](https://pypi.org/proje
|
|||||||
|
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
For full documentation, see the [API reference](https://reference.langchain.com/python/langchain_classic).
|
For full documentation, see the [API reference](https://reference.langchain.com/python/langchain_classic). For conceptual guides, tutorials, and examples on using LangChain, see the [LangChain Docs](https://docs.langchain.com/oss/python/langchain/overview).
|
||||||
|
|
||||||
## 📕 Releases & Versioning
|
## 📕 Releases & Versioning
|
||||||
|
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ LangChain [agents](https://docs.langchain.com/oss/python/langchain/agents) are b
|
|||||||
|
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
For full documentation, see the [API reference](https://reference.langchain.com/python/langchain/langchain/).
|
For full documentation, see the [API reference](https://reference.langchain.com/python/langchain/langchain/). For conceptual guides, tutorials, and examples on using LangChain, see the [LangChain Docs](https://docs.langchain.com/oss/python/langchain/overview).
|
||||||
|
|
||||||
## 📕 Releases & Versioning
|
## 📕 Releases & Versioning
|
||||||
|
|
||||||
|
|||||||
@@ -10,30 +10,30 @@
|
|||||||
|
|
||||||
Centralized reference of LLM capabilities for LangChain chat models.
|
Centralized reference of LLM capabilities for LangChain chat models.
|
||||||
|
|
||||||
## Overview
|
## Quick Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install "langchain[model-profiles]"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🤔 What is this?
|
||||||
|
|
||||||
`langchain-model-profiles` enables programmatic access to model capabilities through a `.profile` property on LangChain chat models.
|
`langchain-model-profiles` enables programmatic access to model capabilities through a `.profile` property on LangChain chat models.
|
||||||
|
|
||||||
This allows you to query model-specific features such as context window sizes, supported input/output modalities, structured output support, tool calling capabilities, and more.
|
This allows you to query model-specific features such as context window sizes, supported input/output modalities, structured output support, tool calling capabilities, and more.
|
||||||
|
|
||||||
|
## 📖 Documentation
|
||||||
|
|
||||||
|
For full documentation, see the [API reference](https://reference.langchain.com/python/langchain_model_profiles/). For conceptual guides, tutorials, and examples on using LangChain, see the [LangChain Docs](https://docs.langchain.com/oss/python/langchain/overview).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Data sources
|
## Data sources
|
||||||
|
|
||||||
This package is built on top of the excellent work by the [models.dev](https://github.com/sst/models.dev) project, an open source initiative that provides model capability data.
|
This package is built on top of the excellent work by the [models.dev](https://github.com/sst/models.dev) project, an open source initiative that provides model capability data.
|
||||||
|
|
||||||
This package augments the data from models.dev with some additional fields. We intend to keep this aligned with the upstream project as it evolves.
|
This package augments the data from models.dev with some additional fields. We intend to keep this aligned with the upstream project as it evolves.
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip install "langchain[model-profiles]"
|
|
||||||
```
|
|
||||||
|
|
||||||
Or with uv:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
uv add "langchain[model-profiles]"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Access model capabilities through the `.profile` property on any LangChain chat model:
|
Access model capabilities through the `.profile` property on any LangChain chat model:
|
||||||
@@ -60,7 +60,3 @@ if profile.get("..."):
|
|||||||
## Available fields
|
## Available fields
|
||||||
|
|
||||||
See `ModelProfile` in [`model_profile.py`](./langchain_model_profiles/model_profile.py) for the full list of available fields and their descriptions.
|
See `ModelProfile` in [`model_profile.py`](./langchain_model_profiles/model_profile.py) for the full list of available fields and their descriptions.
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
MIT
|
|
||||||
|
|||||||
@@ -19,4 +19,14 @@ This package contains the LangChain integration for Anthropic's generative model
|
|||||||
|
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
View the [documentation](https://docs.langchain.com/oss/python/integrations/providers/anthropic) for more details.
|
For full documentation, see the [API reference](https://reference.langchain.com/python/integrations/langchain_anthropic/). For conceptual guides, tutorials, and examples on using these classes, see the [LangChain Docs](https://docs.langchain.com/oss/python/integrations/providers/anthropic).
|
||||||
|
|
||||||
|
## 📕 Releases & Versioning
|
||||||
|
|
||||||
|
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
|
||||||
|
|
||||||
|
## 💁 Contributing
|
||||||
|
|
||||||
|
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
|
||||||
|
|
||||||
|
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
|
||||||
|
|||||||
@@ -19,4 +19,14 @@ This package contains the LangChain integration with DeepSeek.
|
|||||||
|
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
View the [documentation](https://docs.langchain.com/oss/python/integrations/providers/deepseek) for more details.
|
For full documentation, see the [API reference](https://reference.langchain.com/python/integrations/langchain_deepseek/). For conceptual guides, tutorials, and examples on using these classes, see the [LangChain Docs](https://docs.langchain.com/oss/python/integrations/providers/deepseek).
|
||||||
|
|
||||||
|
## 📕 Releases & Versioning
|
||||||
|
|
||||||
|
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
|
||||||
|
|
||||||
|
## 💁 Contributing
|
||||||
|
|
||||||
|
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
|
||||||
|
|
||||||
|
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
|
||||||
|
|||||||
@@ -19,4 +19,14 @@ This is the partner package for tying Fireworks.ai and LangChain. Fireworks real
|
|||||||
|
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
View the [documentation](https://docs.langchain.com/oss/python/integrations/providers/fireworks) for more details.
|
For full documentation, see the [API reference](https://reference.langchain.com/python/integrations/langchain_fireworks/). For conceptual guides, tutorials, and examples on using these classes, see the [LangChain Docs](https://docs.langchain.com/oss/python/integrations/providers/fireworks).
|
||||||
|
|
||||||
|
## 📕 Releases & Versioning
|
||||||
|
|
||||||
|
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
|
||||||
|
|
||||||
|
## 💁 Contributing
|
||||||
|
|
||||||
|
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
|
||||||
|
|
||||||
|
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
|
||||||
|
|||||||
@@ -15,4 +15,14 @@ pip install langchain-groq
|
|||||||
|
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
View the [documentation](https://docs.langchain.com/oss/python/integrations/providers/groq) for more details.
|
For full documentation, see the [API reference](https://reference.langchain.com/python/integrations/langchain_groq/). For conceptual guides, tutorials, and examples on using these classes, see the [LangChain Docs](https://docs.langchain.com/oss/python/integrations/providers/groq).
|
||||||
|
|
||||||
|
## 📕 Releases & Versioning
|
||||||
|
|
||||||
|
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
|
||||||
|
|
||||||
|
## 💁 Contributing
|
||||||
|
|
||||||
|
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
|
||||||
|
|
||||||
|
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
|
||||||
|
|||||||
@@ -19,4 +19,14 @@ This package contains the LangChain integrations for Hugging Face related classe
|
|||||||
|
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
View the [documentation](https://docs.langchain.com/oss/python/integrations/providers/huggingface) for more details.
|
For full documentation, see the [API reference](https://reference.langchain.com/python/integrations/langchain_huggingface/). For conceptual guides, tutorials, and examples on using these classes, see the [LangChain Docs](https://docs.langchain.com/oss/python/integrations/providers/huggingface).
|
||||||
|
|
||||||
|
## 📕 Releases & Versioning
|
||||||
|
|
||||||
|
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
|
||||||
|
|
||||||
|
## 💁 Contributing
|
||||||
|
|
||||||
|
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
|
||||||
|
|
||||||
|
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
|
||||||
|
|||||||
@@ -15,4 +15,14 @@ pip install langchain-mistralai
|
|||||||
|
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
View the [documentation](https://docs.langchain.com/oss/python/integrations/providers/mistralai) for more details.
|
For full documentation, see the [API reference](https://reference.langchain.com/python/integrations/langchain_mistralai/). For conceptual guides, tutorials, and examples on using these classes, see the [LangChain Docs](https://docs.langchain.com/oss/python/integrations/providers/mistralai).
|
||||||
|
|
||||||
|
## 📕 Releases & Versioning
|
||||||
|
|
||||||
|
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
|
||||||
|
|
||||||
|
## 💁 Contributing
|
||||||
|
|
||||||
|
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
|
||||||
|
|
||||||
|
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
|
||||||
|
|||||||
@@ -19,20 +19,14 @@ This package contains the LangChain integration with Ollama
|
|||||||
|
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
View the [documentation](https://docs.langchain.com/oss/python/integrations/providers/ollama) for more details.
|
For full documentation, see the [API reference](https://reference.langchain.com/python/integrations/langchain_ollama/). For conceptual guides, tutorials, and examples on using these classes, see the [LangChain Docs](https://docs.langchain.com/oss/python/integrations/providers/ollama).
|
||||||
|
|
||||||
## Development
|
## 📕 Releases & Versioning
|
||||||
|
|
||||||
### Running Tests
|
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
|
||||||
|
|
||||||
To run integration tests (`make integration_tests`), you will need the following models installed in your Ollama server:
|
## 💁 Contributing
|
||||||
|
|
||||||
- `llama3.1`
|
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
|
||||||
- `deepseek-r1:1.5b`
|
|
||||||
- `gpt-oss:20b`
|
|
||||||
|
|
||||||
Install these models by running:
|
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
|
||||||
|
|
||||||
```bash
|
|
||||||
ollama pull <name-of-model>
|
|
||||||
```
|
|
||||||
|
|||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# Running Tests
|
||||||
|
#
|
||||||
|
# To run integration tests (`make integration_tests`), you will need the following
|
||||||
|
# models installed in your Ollama server:
|
||||||
|
#
|
||||||
|
# - `llama3.1`
|
||||||
|
# - `deepseek-r1:1.5b`
|
||||||
|
# - `gpt-oss:20b`
|
||||||
|
#
|
||||||
|
# Install these models by running:
|
||||||
|
#
|
||||||
|
# ollama pull <name-of-model>
|
||||||
|
|||||||
@@ -19,4 +19,14 @@ This package contains the LangChain integrations for OpenAI through their `opena
|
|||||||
|
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
View the [documentation](https://docs.langchain.com/oss/python/integrations/providers/openai) for more details.
|
For full documentation, see the [API reference](https://reference.langchain.com/python/integrations/langchain_openai/). For conceptual guides, tutorials, and examples on using these classes, see the [LangChain Docs](https://docs.langchain.com/oss/python/integrations/providers/openai).
|
||||||
|
|
||||||
|
## 📕 Releases & Versioning
|
||||||
|
|
||||||
|
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
|
||||||
|
|
||||||
|
## 💁 Contributing
|
||||||
|
|
||||||
|
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
|
||||||
|
|
||||||
|
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
|
||||||
|
|||||||
@@ -19,4 +19,14 @@ This package contains the LangChain integration with Perplexity.
|
|||||||
|
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
View the [documentation](https://docs.langchain.com/oss/python/integrations/providers/perplexity) for more details.
|
For full documentation, see the [API reference](https://reference.langchain.com/python/integrations/langchain_perplexity/). For conceptual guides, tutorials, and examples on using these classes, see the [LangChain Docs](https://docs.langchain.com/oss/python/integrations/providers/perplexity).
|
||||||
|
|
||||||
|
## 📕 Releases & Versioning
|
||||||
|
|
||||||
|
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
|
||||||
|
|
||||||
|
## 💁 Contributing
|
||||||
|
|
||||||
|
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
|
||||||
|
|
||||||
|
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
|
||||||
|
|||||||
@@ -19,4 +19,14 @@ This package contains the LangChain integrations for [xAI](https://x.ai/) throug
|
|||||||
|
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
View the [documentation](https://docs.langchain.com/oss/python/integrations/providers/xai) for more details.
|
For full documentation, see the [API reference](https://reference.langchain.com/python/integrations/langchain_xai/). For conceptual guides, tutorials, and examples on using these classes, see the [LangChain Docs](https://docs.langchain.com/oss/python/integrations/providers/xai).
|
||||||
|
|
||||||
|
## 📕 Releases & Versioning
|
||||||
|
|
||||||
|
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
|
||||||
|
|
||||||
|
## 💁 Contributing
|
||||||
|
|
||||||
|
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
|
||||||
|
|
||||||
|
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
|
||||||
|
|||||||
Reference in New Issue
Block a user