Skip to content

Commit dbf3dab

Browse files
committed
LangChain: Improve README, providing opener badges for Jupyter Notebooks
- Google Colab - Binder @ mybinder.org
1 parent 51d8892 commit dbf3dab

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

framework/langchain/readme.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,33 @@ for the following modules, listed from least to most complex:
2828

2929
## What's inside
3030

31+
[![Made with Jupyter](https://img.shields.io/badge/Made%20with-Jupyter-orange?logo=Jupyter)](https://jupyter.org/try) [![Made with Markdown](https://img.shields.io/badge/Made%20with-Markdown-1f425f.svg?logo=Markdown)](https://commonmark.org)
32+
3133
This folder provides guidelines and runnable code to get started with [LangChain]
3234
and [CrateDB].
3335

3436
- [readme.md](readme.md): The file you are currently reading contains a walkthrough
3537
about how to get started with the LangChain framework and CrateDB, and guides you
3638
to corresponding example programs how to use different subsystems.
39+
3740
- [requirements.txt](requirements.txt): Pulls in a patched version of LangChain,
3841
as well as the CrateDB client driver and the `crash` command-line interface.
39-
- [vector_store.ipynb](vector_search.ipynb): This notebook explores CrateDB's
40-
[`FLOAT_VECTOR`] and [`KNN_MATCH`] functionalities for storing and retrieving
42+
43+
- `vector_store.ipynb` [![Open on GitHub](https://img.shields.io/badge/Open%20on-GitHub-lightgray?logo=GitHub)](vector_search.ipynb) [![Launch Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/crate/cratedb-examples/amo/framework-langchain?labpath=framework%2Flangchain%2Fvector_search.ipynb) [![Open in Collab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/crate/cratedb-examples/blob/amo%2Fframework-langchain/framework/langchain/vector_search.ipynb)
44+
45+
This notebook explores CrateDB's [`FLOAT_VECTOR`] and [`KNN_MATCH`] functionalities for storing and retrieving
4146
embeddings, and for conducting similarity searches.
42-
- [document_loader.ipynb](document_loader.ipynb): The notebook about the Document
43-
Loader demonstrates how to query a database table in CrateDB and use it as a
47+
48+
- `document_loader.ipynb` [![Open on GitHub](https://img.shields.io/badge/Open%20on-GitHub-lightgray?logo=GitHub)](document_loader.ipynb) [![Launch Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/crate/cratedb-examples/amo/framework-langchain?labpath=framework%2Flangchain%2Fdocument_loader.ipynb) [![Open in Collab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/crate/cratedb-examples/blob/amo%2Fframework-langchain/framework/langchain/document_loader.ipynb)
49+
50+
The notebook about the Document Loader demonstrates how to query a database table in CrateDB and use it as a
4451
source provider for LangChain documents.
45-
- [conversational_memory.ipynb](conversational_memory.ipynb): LangChain also
46-
supports managing conversation history in SQL databases. This notebook exercises
52+
53+
- `conversational_memory.ipynb` [![Open on GitHub](https://img.shields.io/badge/Open%20on-GitHub-lightgray?logo=GitHub)](conversational_memory.ipynb) [![Launch Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/crate/cratedb-examples/amo/framework-langchain?labpath=framework%2Flangchain%2Fconversational_memory.ipynb) [![Open in Collab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/crate/cratedb-examples/blob/amo%2Fframework-langchain/framework/langchain/conversational_memory.ipynb)
54+
55+
LangChain also supports managing conversation history in SQL databases. This notebook exercises
4756
how that works with CrateDB.
57+
4858
- Accompanied to the Jupyter Notebook files, there are also basic variants of
4959
corresponding examples, [vector_search.py](vector_search.py),
5060
[document_loader.py](document_loader.py), and

0 commit comments

Comments
 (0)