github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-07-21 12:01:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix lists display issue (#17911)

Browse Source 
**Description:** Fix lists display issues in **Docs > Use Cases > Q&A
with RAG > Quickstart**.

In essence, this PR changes:

```markdown
Some paragraph.
- Item a.
- Item b.
```

to:

```markdown
Some paragraph.

- Item a.
- Item b.
```

There needs an extra empty line to make the list rendered properly.

FYI, the old version is displayed not properly as:

<img width="856" alt="image"
src="https://github.com/langchain-ai/langchain/assets/22856433/65202577-8ea2-47c6-b310-39bf42796fac">

- [x] **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/

Co-authored-by: Bagatur <baskaryan@gmail.com>
This commit is contained in:
AtomicVar 2024-03-09 08:52:16 +08:00 committed by GitHub
parent cf94091cd0
commit 23e62f8f8d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 32 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
docs/docs/use_cases/question_answering/quickstart.mdx
View File

@ -248,12 +248,12 @@ In
### Go deeper ### Go deeper
`DocumentLoader`: Object that loads data from a source as list of `DocumentLoader`: Object that loads data from a source as list of
`Documents`. - `Documents`.
[Docs](../../../docs/modules/data_connection/document_loaders/): - [Docs](../../../docs/modules/data_connection/document_loaders/):
Detailed documentation on how to use `DocumentLoaders`. - Detailed documentation on how to use `DocumentLoaders`.
[Integrations](../../../docs/integrations/document_loaders/): 160+ - [Integrations](../../../docs/integrations/document_loaders/): 160+
integrations to choose from. - integrations to choose from.
[Interface](https://api.python.langchain.com/en/latest/document_loaders/langchain_community.document_loaders.base.BaseLoader.html): - [Interface](https://api.python.langchain.com/en/latest/document_loaders/langchain_community.document_loaders.base.BaseLoader.html):
API reference  for the base interface. API reference  for the base interface.
## 2. Indexing: Split {#indexing-split} ## 2. Indexing: Split {#indexing-split}
@ -318,24 +318,19 @@ all_splits[10].metadata
### Go deeper ### Go deeper
`TextSplitter`: Object that splits a list of `Document`s into smaller `TextSplitter`: Object that splits a list of `Document`s into smaller
chunks. Subclass of `DocumentTransformer`s. - Explore chunks. Subclass of `DocumentTransformer`s.
`Context-aware splitters`, which keep the location (“context”) of each - Explore `Context-aware splitters`, which keep the location (“context”) of each
split in the original `Document`: - [Markdown split in the original `Document`: - [Markdown
files](../../../docs/modules/data_connection/document_transformers/markdown_header_metadata) - files](../../../docs/modules/data_connection/document_transformers/markdown_header_metadata)
[Code (py or - [Code (py or js)](../../../docs/integrations/document_loaders/source_code)
js)](../../../docs/integrations/document_loaders/source_code) - - [Scientific papers](../../../docs/integrations/document_loaders/grobid)
[Scientific - [Interface](https://api.python.langchain.com/en/latest/text_splitter/langchain_text_splitters.TextSplitter.html): API reference for the base interface.
papers](../../../docs/integrations/document_loaders/grobid) -
[Interface](https://api.python.langchain.com/en/latest/text_splitter/langchain_text_splitters.TextSplitter.html):
API reference for the base interface.
`DocumentTransformer`: Object that performs a transformation on a list `DocumentTransformer`: Object that performs a transformation on a list
of `Document`s. - of `Document`s.
[Docs](../../../docs/modules/data_connection/document_transformers/): - [Docs](../../../docs/modules/data_connection/document_transformers/): Detailed documentation on how to use `DocumentTransformers`
Detailed documentation on how to use `DocumentTransformers` - - [Integrations](../../../docs/integrations/document_transformers/)
[Integrations](../../../docs/integrations/document_transformers/) - - [Interface](https://api.python.langchain.com/en/latest/documents/langchain_core.documents.transformers.BaseDocumentTransformer.html): API reference for the base interface.
[Interface](https://api.python.langchain.com/en/latest/documents/langchain_core.documents.transformers.BaseDocumentTransformer.html):
API reference for the base interface.
## 3. Indexing: Store {#indexing-store} ## 3. Indexing: Store {#indexing-store}
@ -365,22 +360,16 @@ vectorstore = Chroma.from_documents(documents=all_splits, embedding=OpenAIEmbedd
### Go deeper ### Go deeper
`Embeddings`: Wrapper around a text embedding model, used for converting `Embeddings`: Wrapper around a text embedding model, used for converting
text to embeddings. - text to embeddings.
[Docs](../../../docs/modules/data_connection/text_embedding): Detailed - [Docs](../../../docs/modules/data_connection/text_embedding): Detailed documentation on how to use embeddings.
documentation on how to use embeddings. - - [Integrations](../../../docs/integrations/text_embedding/): 30+ integrations to choose from.
[Integrations](../../../docs/integrations/text_embedding/): 30+ - [Interface](https://api.python.langchain.com/en/latest/embeddings/langchain_core.embeddings.Embeddings.html): API reference for the base interface.
integrations to choose from. -
[Interface](https://api.python.langchain.com/en/latest/embeddings/langchain_core.embeddings.Embeddings.html):
API reference for the base interface.
`VectorStore`: Wrapper around a vector database, used for storing and `VectorStore`: Wrapper around a vector database, used for storing and
querying embeddings. - querying embeddings.
[Docs](../../../docs/modules/data_connection/vectorstores/): Detailed - [Docs](../../../docs/modules/data_connection/vectorstores/): Detailed documentation on how to use vector stores.
documentation on how to use vector stores. - - [Integrations](../../../docs/integrations/vectorstores/): 40+ integrations to choose from.
[Integrations](../../../docs/integrations/vectorstores/): 40+ - [Interface](https://api.python.langchain.com/en/latest/vectorstores/langchain_core.vectorstores.VectorStore.html): API reference for the base interface.
integrations to choose from. -
[Interface](https://api.python.langchain.com/en/latest/vectorstores/langchain_core.vectorstores.VectorStore.html):
API reference for the base interface.
This completes the **Indexing** portion of the pipeline. At this point This completes the **Indexing** portion of the pipeline. At this point
we have a query-able vector store containing the chunked contents of our we have a query-able vector store containing the chunked contents of our
@ -572,19 +561,15 @@ trace](https://smith.langchain.com/public/1799e8db-8a6d-4eb2-84d5-46e8d7d5a99b/r
#### Choosing a model #### Choosing a model
`ChatModel`: An LLM-backed chat model. Takes in a sequence of messages `ChatModel`: An LLM-backed chat model. Takes in a sequence of messages
and returns a message. - [Docs](../../../docs/modules/model_io/chat/): and returns a message.
Detailed documentation on - - [Docs](../../../docs/modules/model_io/chat/)
[Integrations](../../../docs/integrations/chat/): 25+ integrations to - [Integrations](../../../docs/integrations/chat/): 25+ integrations to choose from.
choose from. - - [Interface](https://api.python.langchain.com/en/latest/language_models/langchain_core.language_models.chat_models.BaseChatModel.html): API reference for the base interface.
[Interface](https://api.python.langchain.com/en/latest/language_models/langchain_core.language_models.chat_models.BaseChatModel.html):
API reference for the base interface.
`LLM`: A text-in-text-out LLM. Takes in a string and returns a string. - `LLM`: A text-in-text-out LLM. Takes in a string and returns a string.
[Docs](../../../docs/modules/model_io/llms) - - [Docs](../../../docs/modules/model_io/llms)
[Integrations](../../../docs/integrations/llms): 75+ integrations to - [Integrations](../../../docs/integrations/llms): 75+ integrations to choose from.
choose from. - - [Interface](https://api.python.langchain.com/en/latest/language_models/langchain_core.language_models.llms.BaseLLM.html): API reference for the base interface.
[Interface](https://api.python.langchain.com/en/latest/language_models/langchain_core.language_models.llms.BaseLLM.html):
API reference for the base interface.
See a guide on RAG with locally-running models See a guide on RAG with locally-running models
[here](../../../docs/use_cases/question_answering/local_retrieval_qa). [here](../../../docs/use_cases/question_answering/local_retrieval_qa).