Update Table of Contents, update metadata page, add name note, fix a few names and typos #495
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@jdye64 I made some updates to the doc build config. Let me know if there are any problems. |
sosahi
reviewed
Feb 27, 2025
| @@ -19,6 +19,9 @@ limitations under the License. | |||
|
|
|||
| The nv-ingest devcontainer is provided as a quick-to-set-up development and exploration environment for use with [Visual Studio Code](https://code.visualstudio.com) (Code). The devcontainer is a lightweight container which mounts-in a Conda environment with cached packages, alleviating long Conda download times on subsequent launches. It provides a simple framework for adding developer-centric [scripts](#development-scripts), and incorporates some helpful Code plugins. | |||
|
|
|||
| > [!Note] | |||
| > NV-Ingest is also known as NVIDIA Ingest and NeMo Retriever Extraction. | |||
There was a problem hiding this comment.
Isabel emphasized we use "e" instead of "E" in Extraction.
So it would be NeMo Retriever extraction.
| @@ -8,6 +8,9 @@ SPDX-License-Identifier: Apache-2.0 | |||
|
|
|||
| NVIDIA-Ingest is a scalable, performance-oriented document content and metadata extraction microservice. Including support for parsing PDFs, Word and PowerPoint documents, it uses specialized NVIDIA NIM microservices to find, contextualize, and extract text, tables, charts and images for use in downstream generative applications. | |||
|
|
|||
| > [!Note] | |||
| > NVIDIA Ingest is also known as NV-Ingest and NeMo Retriever Extraction. | |||
There was a problem hiding this comment.
same here - NeMo Retriever extraction
| @@ -8,6 +8,10 @@ SPDX-License-Identifier: Apache-2.0 | |||
|
|
|||
| NV-Ingest-Client is a tool designed for efficient ingestion and processing of large datasets. It provides both a Python API and a command-line interface to cater to various ingestion needs. | |||
|
|
|||
| > [!Note] | |||
| > NV-Ingest is also known as NVIDIA Ingest and NeMo Retriever Extraction. | |||
There was a problem hiding this comment.
same here - NeMo Retriever extraction
| @@ -3,7 +3,7 @@ hide: | |||
| - navigation | |||
| --- | |||
|
|
|||
| **NV-Ingest** is a scalable, performance-oriented document content and metadata extraction microservice. NV-Ingest uses specialized NVIDIA NIM microservices to find, contextualize, and extract text, tables, charts and images for use in downstream generative applications.. You can access NV-Ingest as a free community resource or learn more about getting an enterprise license for improved expert-level support at the [NV-Ingest homepage](https://www.nvidia.com). | |||
| NeMo Retriever Extraction (NV-Ingest) is a scalable, performance-oriented document content and metadata extraction microservice. NV-Ingest uses specialized NVIDIA NIM microservices to find, contextualize, and extract text, tables, charts and images for use in downstream generative applications.. You can access NV-Ingest as a free community resource or learn more about getting an enterprise license for improved expert-level support at the [NV-Ingest homepage](https://www.nvidia.com). | |||
There was a problem hiding this comment.
Is the URL correct here? It says NV-Ingest homepage but takes the user to nvidia.com
| @@ -1,43 +1,47 @@ | |||
| # What is NVIDIA-Ingest? | |||
| # What is NVIDIA Ingest? | |||
There was a problem hiding this comment.
I thought we would use either NV-Ingest or NeMo Retriever Extraction. Is it necessary to use the 3rd alternative "NVIDIA Ingest" ? Maybe in this example it seems to make more sense to call it NeMo Retriever extraction?
| NV-Ingest is a scalable, performance-oriented document content and metadata extraction microservice. | ||
| NV-Ingest uses specialized NVIDIA NIM microservices | ||
| NVIDIA Ingest is a scalable, performance-oriented document content and metadata extraction microservice. | ||
| NVIDIA Ingest uses specialized NVIDIA NIM microservices |
There was a problem hiding this comment.
Same here and in other places we have used "NVIDIA Ingest". We should replace with either NV-Ingest or NeMo Retriever extraction
randerzander
requested changes
Feb 27, 2025
| @@ -225,7 +228,7 @@ pip install . | |||
|
|
|||
| ### Step 3: Ingesting Documents | |||
|
|
|||
| You can submit jobs programmatically in Python or via the nv-ingest-cli tool. | |||
| You can submit jobs programmatically in Python or via the [NV-Ingest CLI](nv-ingest_cli.md). | |||
There was a problem hiding this comment.
Leave as nv-ingest-cli
| @@ -130,7 +130,7 @@ pip install . | |||
| ## Step 3: Ingesting Documents | |||
| You can submit jobs programmatically in Python or using the nv-ingest-cli tool. | |||
| You can submit jobs programmatically in Python or using the [NV-Ingest CLI](nv-ingest_cli.md). | |||
There was a problem hiding this comment.
Leave as nv-ingest-cli
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Update Table of Contents, update metadata page, add name note, fix a few names and typos
This pr replaces #463