diff --git a/libs/core/README.md b/libs/core/README.md index 80cfbe0d8ec..ee35e758add 100644 --- a/libs/core/README.md +++ b/libs/core/README.md @@ -34,7 +34,7 @@ The LangChain ecosystem is built on top of `langchain-core`. Some of the benefit ## 📖 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 diff --git a/libs/langchain/README.md b/libs/langchain/README.md index 32c6b513f75..db251956701 100644 --- a/libs/langchain/README.md +++ b/libs/langchain/README.md @@ -24,7 +24,7 @@ In most cases, you should be using the main [`langchain`](https://pypi.org/proje ## 📖 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 diff --git a/libs/langchain_v1/README.md b/libs/langchain_v1/README.md index 49db352a0f0..514e3ecdc2b 100644 --- a/libs/langchain_v1/README.md +++ b/libs/langchain_v1/README.md @@ -26,7 +26,7 @@ LangChain [agents](https://docs.langchain.com/oss/python/langchain/agents) are b ## 📖 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 diff --git a/libs/model-profiles/README.md b/libs/model-profiles/README.md index 8cd8da0d8a2..d1c9ee49c7a 100644 --- a/libs/model-profiles/README.md +++ b/libs/model-profiles/README.md @@ -10,30 +10,30 @@ 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. 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 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. -## Installation - -```bash -pip install "langchain[model-profiles]" -``` - -Or with uv: - -```bash -uv add "langchain[model-profiles]" -``` - ## Usage Access model capabilities through the `.profile` property on any LangChain chat model: @@ -60,7 +60,3 @@ if profile.get("..."): ## Available fields See `ModelProfile` in [`model_profile.py`](./langchain_model_profiles/model_profile.py) for the full list of available fields and their descriptions. - -## License - -MIT diff --git a/libs/partners/anthropic/README.md b/libs/partners/anthropic/README.md index 3279b87b0f6..35889d8f790 100644 --- a/libs/partners/anthropic/README.md +++ b/libs/partners/anthropic/README.md @@ -19,4 +19,14 @@ This package contains the LangChain integration for Anthropic's generative model ## 📖 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). diff --git a/libs/partners/deepseek/README.md b/libs/partners/deepseek/README.md index 523f142df7f..805bb63b457 100644 --- a/libs/partners/deepseek/README.md +++ b/libs/partners/deepseek/README.md @@ -19,4 +19,14 @@ This package contains the LangChain integration with DeepSeek. ## 📖 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). diff --git a/libs/partners/fireworks/README.md b/libs/partners/fireworks/README.md index 1e8dc6271ba..c234702e401 100644 --- a/libs/partners/fireworks/README.md +++ b/libs/partners/fireworks/README.md @@ -19,4 +19,14 @@ This is the partner package for tying Fireworks.ai and LangChain. Fireworks real ## 📖 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). diff --git a/libs/partners/groq/README.md b/libs/partners/groq/README.md index b3d9ab7ef0f..4d336229388 100644 --- a/libs/partners/groq/README.md +++ b/libs/partners/groq/README.md @@ -15,4 +15,14 @@ pip install langchain-groq ## 📖 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). diff --git a/libs/partners/huggingface/README.md b/libs/partners/huggingface/README.md index 7a8ba6295fe..a7a4784e59e 100644 --- a/libs/partners/huggingface/README.md +++ b/libs/partners/huggingface/README.md @@ -19,4 +19,14 @@ This package contains the LangChain integrations for Hugging Face related classe ## 📖 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). diff --git a/libs/partners/mistralai/README.md b/libs/partners/mistralai/README.md index 1caf2ca5fcd..6e3c3023f87 100644 --- a/libs/partners/mistralai/README.md +++ b/libs/partners/mistralai/README.md @@ -15,4 +15,14 @@ pip install langchain-mistralai ## 📖 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). diff --git a/libs/partners/ollama/README.md b/libs/partners/ollama/README.md index 627611c875f..1f728523175 100644 --- a/libs/partners/ollama/README.md +++ b/libs/partners/ollama/README.md @@ -19,20 +19,14 @@ This package contains the LangChain integration with Ollama ## 📖 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` -- `deepseek-r1:1.5b` -- `gpt-oss:20b` +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. -Install these models by running: - -```bash -ollama pull -``` +For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview). diff --git a/libs/partners/ollama/tests/__init__.py b/libs/partners/ollama/tests/__init__.py index e69de29bb2d..2e39a462da4 100644 --- a/libs/partners/ollama/tests/__init__.py +++ b/libs/partners/ollama/tests/__init__.py @@ -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 diff --git a/libs/partners/openai/README.md b/libs/partners/openai/README.md index 2cb2c569b9b..b2ccecfd5eb 100644 --- a/libs/partners/openai/README.md +++ b/libs/partners/openai/README.md @@ -19,4 +19,14 @@ This package contains the LangChain integrations for OpenAI through their `opena ## 📖 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). diff --git a/libs/partners/perplexity/README.md b/libs/partners/perplexity/README.md index 0c79d42a17c..70839f717d2 100644 --- a/libs/partners/perplexity/README.md +++ b/libs/partners/perplexity/README.md @@ -19,4 +19,14 @@ This package contains the LangChain integration with Perplexity. ## 📖 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). diff --git a/libs/partners/xai/README.md b/libs/partners/xai/README.md index 872a5b6b7eb..72c5efc416f 100644 --- a/libs/partners/xai/README.md +++ b/libs/partners/xai/README.md @@ -19,4 +19,14 @@ This package contains the LangChain integrations for [xAI](https://x.ai/) throug ## 📖 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).