Skip to content

Commit

Permalink
FIx Doc links and other documentation issue (run-llama#9632)
Browse files Browse the repository at this point in the history
* Update CHANGELOG.md

* Update agents.md

* Updated understanding.md (run-llama#51)

* Grammatical_error in docs/api_reference/query.rst

* Grammatical error in docs/end_to_end_tutorials/dev_practices/e2e_evaluation.md

* Changed word from unstructed to unstructured

* Corrected the spelling of performing

* Update evaluating.md

Corrected the spelling of "guidelines"

* Update evaluation.md

Changed " things are working will together" to " things are working well together"

* Update usage_pattern.md (#2)

* Update usage_pattern.md

Corrected the spellings of measure.

* Update basic_strategies.md

* Update (#8)

* Introduce Google Generative Language Semantic Retriever (run-llama#9440)

* Add a Gemini models for text and multi-modal. (run-llama#9452)

* Add a Gemini models for text and multi-modal.

Includes each of {text, mm} x {completion, chat} x {stream, one-shot}
x {sync, async} for Gemini's Developer API.

And two notebooks - regular text & multi-modal.

* add gemini into doc and rename MM example file

* Add version constraints to pip install

And remove noisy output.

* Enrich Gemini Example

* cr

* Use gemini-pro instead of ultra

* cr

* cr

* cr

---------

Co-authored-by: Haotian Zhang <[email protected]>

* [version] bump to v0.9.15 (run-llama#9485)

* use persist dir in faiss (run-llama#9486)

* Gemini Embedding (run-llama#9476)

* Gemini Embedding

* cr

* Merge Gemini Same Role Chat Message (run-llama#9498)

* Fix Gemini Same Role Chat Msg

* cr

* cr

* cr

* cr

* Teeny stray link causing weirdness (run-llama#9501)

* Fixing CHANGELOG for wrong PR ID (run-llama#9505)

* Overhauling indexing to emphasize VectorStoreIndex and SEO

* Expanding use-cases docs: Q&A and chatbots

* Fix small bug in string method of NodeWithScore (run-llama#9494)

Update schema.py

Avoid exception in __str__ method of NodeWithScore when the optional member variable self.score is None.

* Added missing `default=None` to `LLM.system_prompt` (run-llama#9504)

* Adding default=None to system_prompt to fix type errors

* Added CHANGELOG entry

* Update PDFReader (run-llama#9508)

Add to PDFReader so that a user can specify if they want the PDF read in as one whole Document, or each page as a Document.

* Updating Spelling Mistakes (run-llama#9513)

* Grammatical_error in docs/api_reference/query.rst

* Grammatical error in docs/end_to_end_tutorials/dev_practices/e2e_evaluation.md

* Changed word from unstructed to unstructured

* Corrected the spelling of performing

---------

Co-authored-by: KamalSharmaShorthillsAI <[email protected]>
Co-authored-by: Haotian Zhang <[email protected]>
Co-authored-by: UpneetShorthillsAI <[email protected]>

* FIxing Grammatical issues in docs (run-llama#9514)

* Fixing Docs (run-llama#9515)

* Allowing `LOCALAI_DEFAULTS` to work with `__ror__` (run-llama#9502)

---------

Co-authored-by: Lawrence Tsang <[email protected]>
Co-authored-by: Mark McDonald <[email protected]>
Co-authored-by: Haotian Zhang <[email protected]>
Co-authored-by: Logan <[email protected]>
Co-authored-by: Laurie Voss <[email protected]>
Co-authored-by: James Braza <[email protected]>
Co-authored-by: Max <[email protected]>
Co-authored-by: Alex McGraw <[email protected]>
Co-authored-by: KamalSharmaShorthillsAI <[email protected]>
Co-authored-by: UpneetShorthillsAI <[email protected]>

* Update train_questions.txt (#5)

removed a from a developing

* updated basic_strategies.md and building_rag_from_scratch.md files (#6)

* Update basic_strategies.md

* Update building_rag_from_scratch.md

* Update deprecated_terms.md , changed "THe" to "The"

* Update graph_stores.md

* Update guidance.md

* Update vector_stores.md

* This PR addresses grammatical and clarity enhancements. (#7)

* Update structured_outputs.md

 Grammatical Improvements

* Update query_transformations.md

Changed followup to follow-up.

* Update structured_outputs.md

---------

Co-authored-by: Shorthills AI <[email protected]>

* made a grammatical correction (#10)

* Update train_questions.txt

removed a from a developing

* Update agents.md

removed a from a more information

* Update gatsby_license.txt (#11)

* Update gatsby_license.txt

grammar and tense correction: "read, understand, agree to and accept all the terms" to "read, understood, and agreed to accept all the terms", "do not agree" to "disagree", "agreement for keeping" to "agreement to keep", "unlink or detach or remove" to "unlink, detach or remove", "statements concerning tax" to "statements concerning the tax"

* Update concepts.md

grammar and tense correction: "or retrieved data" to "or retrieve data", "data which is" to "data that is", "class, are responsible" to "class, is responsible"," that allow you to ask question" to "that allows you to ask questions".

* Update discover_llamaindex.md (run-llama#15)

* Update llms.md (#9)

Corrected spellings of 'results'.

* Update llms.md (#13)

Corrected spelling of results.

* Update CHANGELOG.md (run-llama#14)

fixed the spelling mistake of  the evaluation

* Update deprecated_terms.md

Links Urls in Deprecated_terms is not working.
1. Configuring settings in the Service Context Link updated.
2. Parsing Documents into Nodes Link updated.
3. LLMs in LlamaIndex Link updated.
4. Setting LLMs in the ServiceContext updated

* Update deprecated_terms.md

Links Updated in Deprecated_terms mentioned below:
1. Index Usage Pattern link updated.
2. Vector Store Guide link updated
3. Vector Store Integrations link updated.
4. Index Usage Pattern link updated.
5. Vector Store Guide link updated.
6. Vector Store Integrations link updated.

* Update deprecated_terms.md

GPTVectorStoreIndex "Index Usage Pattern" Link updated.

* Update chatbots.md

Improve clarity and consistency in the Chatbots section of the documentation:
1. Corrected the term 'LLM's' to 'LLMs' for consistency.
2. Modified 'Here's some relevant resources' to 'Here are some relevant resources' for grammatical correctness.

* Update chatbots.md with spelling : chatbots

Previous : chat  bots
Corrected : chatbots

* Update multimodal.md

removed an extra word : "out" for consistency and clarity

* Update chatbots.md

* Update agents.md

* Update embeddings.md

* Update understanding.md

* Update extraction.md

---------

Co-authored-by: KamalSharmaShorthillsAI <[email protected]>
Co-authored-by: Shorthills AI <[email protected]>
Co-authored-by: Haotian Zhang <[email protected]>
Co-authored-by: UpneetShorthillsAI <[email protected]>
Co-authored-by: ManpreetShorthillsAI <[email protected]>
Co-authored-by: SakshiShorthillsAI <[email protected]>
Co-authored-by: Lawrence Tsang <[email protected]>
Co-authored-by: Mark McDonald <[email protected]>
Co-authored-by: Logan <[email protected]>
Co-authored-by: Laurie Voss <[email protected]>
Co-authored-by: James Braza <[email protected]>
Co-authored-by: Max <[email protected]>
Co-authored-by: Alex McGraw <[email protected]>
Co-authored-by: Aayush <[email protected]>
Co-authored-by: Saransh Sharma <[email protected]>
Co-authored-by: AbhishekYadavShorthillsAI <[email protected]>
Co-authored-by: AryamanJaiswalShorthillsAI <[email protected]>
Co-authored-by: Sanskar Tanwar <[email protected]>
Co-authored-by: ShreeramKumawatShorthillsAI <[email protected]>
Co-authored-by: Vishal <[email protected]>
Co-authored-by: AashutoshPathakShorthillsAI <[email protected]>
Co-authored-by: Rajneesh Singh <[email protected]>
Co-authored-by: VagishaMisraShorthillsAI <[email protected]>
Co-authored-by: PankajKumarShorthillsAI <[email protected]>
Co-authored-by: Adarsh Shrivastav <[email protected]>
Co-authored-by: Puneet Dhiman <[email protected]>
Co-authored-by: AmitSinghShorthillsAI <[email protected]>

* Update embeddings.md

* Update embeddings.md

* Update embeddings.md

* Update embeddings.md

---------

Co-authored-by: ChetnaGuptaShorthillsAI <[email protected]>
Co-authored-by: Puneet Dhiman <[email protected]>
Co-authored-by: AdityaKalraShorthillsAI <[email protected]>
Co-authored-by: KamalSharmaShorthillsAI <[email protected]>
Co-authored-by: Haotian Zhang <[email protected]>
Co-authored-by: UpneetShorthillsAI <[email protected]>
Co-authored-by: ManpreetShorthillsAI <[email protected]>
Co-authored-by: SakshiShorthillsAI <[email protected]>
Co-authored-by: Lawrence Tsang <[email protected]>
Co-authored-by: Mark McDonald <[email protected]>
Co-authored-by: Logan <[email protected]>
Co-authored-by: Laurie Voss <[email protected]>
Co-authored-by: James Braza <[email protected]>
Co-authored-by: Max <[email protected]>
Co-authored-by: Alex McGraw <[email protected]>
Co-authored-by: Aayush <[email protected]>
Co-authored-by: Saransh Sharma <[email protected]>
Co-authored-by: AbhishekYadavShorthillsAI <[email protected]>
Co-authored-by: AryamanJaiswalShorthillsAI <[email protected]>
Co-authored-by: Sanskar Tanwar <[email protected]>
Co-authored-by: ShreeramKumawatShorthillsAI <[email protected]>
Co-authored-by: Vishal <[email protected]>
Co-authored-by: AashutoshPathakShorthillsAI <[email protected]>
Co-authored-by: Rajneesh Singh <[email protected]>
Co-authored-by: VagishaMisraShorthillsAI <[email protected]>
Co-authored-by: PankajKumarShorthillsAI <[email protected]>
Co-authored-by: Adarsh Shrivastav <[email protected]>
Co-authored-by: AmitSinghShorthillsAI <[email protected]>
  • Loading branch information
1 parent d465b3e commit d896b3a
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
- Gemini Model Checks (#9563)
- Update OpenAI fine-tuning with latest changes (#9564)
- fix/Reintroduce `WHERE` filter to the Sparse Query for PgVectorStore (#9529)
- Update Ollama API for ollama v0.1.16 (#9558)
- Update Ollama API to ollama v0.1.16 (#9558)
- ollama: strip invalid `formatted` option (#9555)
- add a device in optimum push #9541 (#9554)
- Title vs content difference for Gemini Embedding (#9547)
Expand Down Expand Up @@ -206,7 +206,7 @@
### Bug Fixes / Nits

- Fixed bug in formatting chat prompt templates when estimating chunk sizes (#9025)
- Sandboxed Pandas execution, remidiate CVE-2023-39662 (#8890)
- Sandboxed Pandas execution, remediate CVE-2023-39662 (#8890)
- Restored `mypy` for Python 3.8 (#9031)
- Loosened `dataclasses-json` version range,
and removes unnecessary `jinja2` extra from `pandas` (#9042)
Expand Down
4 changes: 2 additions & 2 deletions docs/module_guides/models/embeddings.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You can find more usage details and available customization options below.

## Getting Started

The most common usage for an embedding model will be setting it in the service context object, and then using it to construct an index and query. The input documents will be broken into nodes, and the emedding model will generate an embedding for each node.
The most common usage for an embedding model will be setting it in the service context object, and then using it to construct an index and query. The input documents will be broken into nodes, and the embedding model will generate an embedding for each node.

By default, LlamaIndex will use `text-embedding-ada-002`, which is what the example below manually sets up for you.

Expand All @@ -47,7 +47,7 @@ from llama_index.embeddings import OpenAIEmbedding
embed_model = OpenAIEmbedding()
service_context = ServiceContext.from_defaults(embed_model=embed_model)

# optionally set a global service context to avoid passing it into other objects every time
# Optionally set a global service context to avoid passing it into other objects every time
from llama_index import set_global_service_context

set_global_service_context(service_context)
Expand Down
4 changes: 2 additions & 2 deletions docs/understanding/understanding.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Building an LLM application

Welcome to the start of Understanding LlamaIndex. This is a series of short, bite-sized tutorials on every stage of building an LLM application to get you acquainted with how to use LlamaIndex before diving into more advanced and subtle strategies. If you're an experienced programmer new to LlamaIndex, this is the place to start.
Welcome to the beginning of Understanding LlamaIndex. This is a series of short, bite-sized tutorials on every stage of building an LLM application to get you acquainted with how to use LlamaIndex before diving into more advanced and subtle strategies. If you're an experienced programmer new to LlamaIndex, this is the place to start.

## Key steps in building an LLM application

Expand All @@ -24,7 +24,7 @@ There are a series of key steps involved in building any LLM-powered application

- **[Tracing and debugging](/understanding/tracing_and_debugging/tracing_and_debugging.md)**: also called **observability**, it's especially important with LLM applications to be able to look into the inner workings of what's going on to help you debug problems and spot places to improve.

- **[Evaluating](/understanding/evaluating/evaluating.md)**: every strategy has pros and cons and a key part of building, shipping and evolving your application is evaluating whether your change has improved your application in terms of accuracy, performance, clarity, cost and more. Reliably evaluating your changes is a big part of LLM application development.
- **[Evaluating](/understanding/evaluating/evaluating.md)**: every strategy has pros and cons and a key part of building, shipping and evolving your application is evaluating whether your change has improved your application in terms of accuracy, performance, clarity, cost and more. Reliably evaluating your changes is a crucial part of LLM application development.

## Let's get started!

Expand Down
2 changes: 1 addition & 1 deletion docs/use_cases/agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ more information + a detailed analysis.

## Learn more

Our Putting It All Together section has [more on agents](/understanding/putting_it_all_together/agents.md)
Our Putting It All Together section has [more on agents](/docs/understanding/putting_it_all_together/agents.md)
8 changes: 4 additions & 4 deletions docs/use_cases/chatbots.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Chatbots

Chatbots are another extremely popular use case for LLM's. Instead of a single question and answer, a chatbot can handle multiple back-and-forth queries and answers, getting clarification or answering follow-up questions.
Chatbots are another extremely popular use case for LLMs. Instead of a single question and answer, a chatbot can handle multiple back-and-forth queries and answers, getting clarification or answering follow-up questions.

LlamaIndex gives you the tools to build knowledge-augmented chatbots and agents.

Here's some relevant resources:
Here are some relevant resources:

- [Building a chatbot](/understanding/putting_it_all_together/chatbots/building_a_chatbot.md) tutorial
- [Building a chatbot](/docs/understanding/putting_it_all_together/chatbots/building_a_chatbot.md) tutorial
- [create-llama](https://blog.llamaindex.ai/create-llama-a-command-line-tool-to-generate-llamaindex-apps-8f7683021191), a command line tool that generates a full-stack chatbot application for you
- [SECinsights.ai](https://www.secinsights.ai/), an open-source application that uses LlamaIndex to build a chatbot that answers questions about SEC filings
- [RAGs](https://blog.llamaindex.ai/introducing-rags-your-personalized-chatgpt-experience-over-your-data-2b9d140769b1), a project inspired by OpenAI's GPTs that lets you build a low-code chatbot over your data using Streamlit
- Our [OpenAI agents](/module_guides/deploying/agents/modules.md) are all chat bots in nature
- Our [OpenAI agents](/docs/module_guides/deploying/agents/modules.md) are all chat bots in nature

## External sources

Expand Down
4 changes: 2 additions & 2 deletions docs/use_cases/extraction.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ Once you have structured data you can send them to a database, or you can parse

Examples:

- [Extracting names and locations from descriptions of people](/examples/output_parsing/df_program.ipynb)
- [Extracting album data from music reviews](/examples/llm/llama_api.ipynb)
- [Extracting names and locations from descriptions of people](/docs/examples/output_parsing/df_program.ipynb)
- [Extracting album data from music reviews](/docs/examples/llm/llama_api.ipynb)
2 changes: 1 addition & 1 deletion docs/use_cases/multimodal.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ maxdepth: 1
### Using Chroma for Multi-Modal retrieval with single vector store

Chroma vector DB supports single vector store for indexing both images and texts.
Check out out Chroma + LlamaIndex integration with single Multi-Modal Vector Store for both images/texts index and retrieval.
Check out Chroma + LlamaIndex integration with single Multi-Modal Vector Store for both images/texts index and retrieval.

```{toctree}
---
Expand Down

0 comments on commit d896b3a

Please sign in to comment.