Simplifying README, adding library mode example #393
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
nkmcalli
reviewed
Jan 30, 2025
nkmcalli
reviewed
Jan 30, 2025
nkmcalli
reviewed
Jan 30, 2025
| @@ -37,322 +37,137 @@ A service that: | |||
| - Runs a static pipeline or fixed set of operations on every submitted document. | |||
| - Acts as a wrapper for any specific document parsing library. | |||
|
|
|||
| For production level performance and scalability, we recommend deploying the pipeline and supporting NIMs via docker-compose or kubernetes (via the provided helm charts). | |||
There was a problem hiding this comment.
Suggested change
| For production level performance and scalability, we recommend deploying the pipeline and supporting NIMs via docker-compose or kubernetes (via the provided helm charts). | |
| For production-level performance and scalability, we recommend that you deploy the pipeline and supporting NIMs by using Docker Compose or Kubernetes. You can use the helm charts provided. |
There was a problem hiding this comment.
Also, can you link from here to the helm charts?
nkmcalli
reviewed
Jan 30, 2025
|
|
||
| ## Prerequisites | ||
| For hardware and software pre-requisites for container and kubernetes (helm) based deployments, please find [our comprehensive doc site](https://docs.nvidia.com/nv-ingest/user-guide/getting-started/prerequisites/). |
There was a problem hiding this comment.
Suggested change
| For hardware and software pre-requisites for container and kubernetes (helm) based deployments, please find [our comprehensive doc site](https://docs.nvidia.com/nv-ingest/user-guide/getting-started/prerequisites/). | |
| For hardware and software requirements for container- and Kubernetes-based deployments, refer to [Prerequisites](https://docs.nvidia.com/nv-ingest/user-guide/getting-started/prerequisites/). |
nkmcalli
reviewed
Jan 30, 2025
|
|
||
| ### Software | ||
| To facilitate an easier evaluation experience, and for small scale (<100 PDFs) workloads, you can use our "library mode" setup, which depends on NIMs either already self hosted, or, by default, NIMs hosted on build.nvidia.com. |
There was a problem hiding this comment.
Suggested change
| To facilitate an easier evaluation experience, and for small scale (<100 PDFs) workloads, you can use our "library mode" setup, which depends on NIMs either already self hosted, or, by default, NIMs hosted on build.nvidia.com. | |
| For small-scale workloads, such as workloads of fewer than 100 PDFs, you can use library mode setup. Library mode set up depends on NIMs that are already self-hosted, or, by default, NIMs that are hosted on build.nvidia.com. |
Co-authored-by: nkmcalli <[email protected]>
Co-authored-by: nkmcalli <[email protected]>
drobison00
requested changes
Feb 19, 2025
| > From the bash prompt above, you can run nv-ingest-cli and Python examples described below. | ||
|
|
||
| ### Step 3: Ingesting Documents | ||
| Note: To use library mode with self hosted NIMs: TODO |
|
|
||
| > [!IMPORTANT] | ||
| > `extract_tables` controls extraction for both tables and charts. You can optionally disable chart extraction by setting `extract_charts` to false. | ||
| 5. Start ingesting and retrieving documents: |
There was a problem hiding this comment.
Generally seems fine, although I do think having the associated CLI command would be a good idea for anyone who doesn't wants a code-free approach.
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.
No description provided.