Fix quickstart docs: add client install step and correct run_pipeline API notes#1738
Open
kheiss-uwzoo wants to merge 3 commits intoNVIDIA:26.03from
Open
Fix quickstart docs: add client install step and correct run_pipeline API notes#1738kheiss-uwzoo wants to merge 3 commits intoNVIDIA:26.03from
kheiss-uwzoo wants to merge 3 commits intoNVIDIA:26.03from
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
PR Summary
This branch contains 3 commits on top of origin/26.03 and changes 2 docs files.
Summary
Updates docs/docs/extraction/quickstart-guide.md to add a missing client-install step before ingestion:
Introduces a new Step 2: Install the Client with Python 3.12 uv setup/install commands.
Renumbers subsequent sections (Ingest Documents becomes Step 3, inspection becomes Step 4).
Refreshes sample output paths to generic Python 3.12-friendly examples.
Updates docs/docs/extraction/quickstart-library-mode.md with explicit run_pipeline API corrections:
Marks pipeline_config, run_in_subprocess, and block as optional (Required: No semantics).
Corrects non-blocking subprocess return type to RayPipelineSubprocessInterface (not RayPipelineInterface).