github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-06-22 06:39:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix incorrect code blocks in documentation (#9060)

Browse Source 
Fixes incorrect code block syntax in doc strings.
This commit is contained in:
Eugene Yurtsev 2023-08-10 17:13:42 -04:00 committed by GitHub
parent 46f3428cb3
commit 67ca187560
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 47 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
libs/langchain/langchain/document_loaders/blob_loaders/file_system.py
View File

@ -74,26 +74,23 @@ class FileSystemBlobLoader(BlobLoader):
Examples:
... code-block:: python
.. code-block:: python
# Recursively load all text files in a directory.
loader = FileSystemBlobLoader("/path/to/directory", glob="**/*.txt")
# Recursively load all text files in a directory.
loader = FileSystemBlobLoader("/path/to/directory", glob="**/*.txt")
# Recursively load all files in a directory, except for py or pyc files.
loader = FileSystemBlobLoader(
"/path/to/directory",
glob="**/*.txt",
exclude=["**/*.py", "**/*.pyc"]
)
# Recursively load all non-hidden files in a directory.
loader = FileSystemBlobLoader("/path/to/directory", glob="**/[!.]*")
# Recursively load all non-hidden files in a directory.
loader = FileSystemBlobLoader("/path/to/directory", glob="**/[!.]*")
# Load all files in a directory without recursion.
loader = FileSystemBlobLoader("/path/to/directory", glob="*")
# Load all files in a directory without recursion.
# Load all files in a directory without recursion.
loader = FileSystemBlobLoader("/path/to/directory", glob="*")
# Recursively load all files in a directory, except for py or pyc files.
loader = FileSystemBlobLoader(
"/path/to/directory",
glob="**/*.txt",
exclude=["**/*.py", "**/*.pyc"]
)
"""
if isinstance(path, Path):
_path = path

6
libs/langchain/langchain/document_loaders/generic.py
View File

@ -22,7 +22,7 @@ class GenericLoader(BaseLoader):
Examples:
.. code-block:: python
.. code-block:: python
from langchain.document_loaders import GenericLoader
from langchain.document_loaders.blob_loaders import FileSystemBlobLoader
@ -39,7 +39,7 @@ class GenericLoader(BaseLoader):
Example instantiations to change which files are loaded:
... code-block:: python
.. code-block:: python
# Recursively load all text files in a directory.
loader = GenericLoader.from_filesystem("/path/to/dir", glob="**/*.txt")
@ -52,7 +52,7 @@ class GenericLoader(BaseLoader):
Example instantiations to change which parser is used:
... code-block:: python
.. code-block:: python
from langchain.document_loaders.parsers.pdf import PyPDFParser

6
libs/langchain/langchain/document_loaders/parsers/language/language_parser.py
View File

@ -35,7 +35,7 @@ class LanguageParser(BaseBlobParser):
Examples:
.. code-block:: python
.. code-block:: python
from langchain.text_splitter.Language
from langchain.document_loaders.generic import GenericLoader
@ -51,7 +51,7 @@ class LanguageParser(BaseBlobParser):
Example instantiations to manually select the language:
... code-block:: python
.. code-block:: python
from langchain.text_splitter import Language
@ -64,7 +64,7 @@ class LanguageParser(BaseBlobParser):
Example instantiations to set number of lines threshold:
... code-block:: python
.. code-block:: python
loader = GenericLoader.from_filesystem(
"./code",

45
libs/langchain/langchain/retrievers/parent_document_retriever.py
View File

@ -30,31 +30,32 @@ class ParentDocumentRetriever(BaseRetriever):
chunk.
Examples:
... code-block:: python
# Imports
from langchain.vectorstores import Chroma
from langchain.embeddings import OpenAIEmbeddings
from langchain.text_splitter import RecursiveCharacterTextSplitter
from langchain.storage import InMemoryStore
.. code-block:: python
# This text splitter is used to create the parent documents
parent_splitter = RecursiveCharacterTextSplitter(chunk_size=2000)
# This text splitter is used to create the child documents
# It should create documents smaller than the parent
child_splitter = RecursiveCharacterTextSplitter(chunk_size=400)
# The vectorstore to use to index the child chunks
vectorstore = Chroma(embedding_function=OpenAIEmbeddings())
# The storage layer for the parent documents
store = InMemoryStore()
# Imports
from langchain.vectorstores import Chroma
from langchain.embeddings import OpenAIEmbeddings
from langchain.text_splitter import RecursiveCharacterTextSplitter
from langchain.storage import InMemoryStore
# Initialize the retriever
retriever = ParentDocumentRetriever(
vectorstore=vectorstore,
docstore=store,
child_splitter=child_splitter,
parent_splitter=parent_splitter,
)
# This text splitter is used to create the parent documents
parent_splitter = RecursiveCharacterTextSplitter(chunk_size=2000)
# This text splitter is used to create the child documents
# It should create documents smaller than the parent
child_splitter = RecursiveCharacterTextSplitter(chunk_size=400)
# The vectorstore to use to index the child chunks
vectorstore = Chroma(embedding_function=OpenAIEmbeddings())
# The storage layer for the parent documents
store = InMemoryStore()
# Initialize the retriever
retriever = ParentDocumentRetriever(
vectorstore=vectorstore,
docstore=store,
child_splitter=child_splitter,
parent_splitter=parent_splitter,
)
"""
vectorstore: VectorStore

3
libs/langchain/langchain/storage/in_memory.py
View File

@ -16,7 +16,8 @@ class InMemoryStore(BaseStore[str, Any]):
the key-value pairs.
Examples:
... code-block:: python
.. code-block:: python
from langchain.storage import InMemoryStore

4
libs/langchain/langchain/tools/base.py
View File

@ -663,7 +663,9 @@ class StructuredTool(BaseTool):
The tool
Examples:
... code-block:: python
.. code-block:: python
def add(a: int, b: int) -> int:
\"\"\"Add two numbers\"\"\"
return a + b