Refine DocIndexRetriever READMEs #2180
Merged
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
Signed-off-by: Yi Yao <yi.a.yao@intel.com>
joshuayao
requested review from
ashahba,
lkk12014402,
xuechendi and
ZePan110
as code owners
Dependency Review✅ No vulnerabilities or license issues found.Scanned FilesNone |
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Pull Request Overview
This PR refines the DocIndexRetriever README documentation by reorganizing deployment information and removing detailed API parameter examples. The changes improve the documentation structure by replacing verbose sections with a cleaner deployment options table format.
- Replaces unstructured deployment description with organized table format
- Removes detailed API parameter examples and hyperparameter configuration section
- Maintains essential deployment links while improving readability
ZePan110
approved these changes
Aug 8, 2025
letonghan
approved these changes
Aug 8, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
for more information, see https://pre-commit.ci
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
Refine DocIndexRetriever READMEs.
Issues
n/a.Type of change
List the type of change like below. Please delete options that are not relevant.