doc: fix quickstart section for Milvus Lite

[nathan-weinberg]

User description

As of milvus-io/pymilvus#2976 milvus-lite is no longer included as part of the default pymilvus installation and must be explicitly specified

---

PR Type

Documentation

---

Description

• Update installation docs to reflect milvus-lite as optional dependency

• Clarify explicit installation requirement for Milvus Lite functionality

---

Diagram Walkthrough

flowchart LR
  A["pymilvus default install"] -- "does not include" --> B["Milvus Lite"]
  C["pymilvus[milvus-lite]"] -- "includes" --> B
  B -- "enables" --> D["Local vector database"]

Loading

File Walkthrough

Relevant files

Documentation

README.md Clarify Milvus Lite as optional dependency                              README.md Updated installation documentation to clarify that milvus-lite is no longer included by default Changed wording from "includes Milvus Lite" to "can try Milvus Lite by installing pymilvus[milvus-lite]" Reflects the breaking change from pymilvus PR Merge scalar-field-filtering to master #2976 where milvus-lite became an optional dependency +1/-1

---

Summary by CodeRabbit

• Documentation
  • Updated Milvus Lite installation guidance to specify the proper installation method using the optional feature specification.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[sre-ci-robot]

Welcome @nathan-weinberg! It looks like this is your first PR to milvus-io/milvus 🎉

[qodo-code-review]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪	🎫 No ticket provided Create ticket/issue
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
🟢	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[coderabbitai]

Walkthrough

The README.md documentation is updated to clarify the installation method for Milvus Lite. Instead of indicating it is included with pymilvus, users are now instructed to install it via the optional feature specification pymilvus[milvus-lite]. No functional changes are made.

Changes

Cohort / File(s)	Summary
Documentation update README.md	Revised Milvus Lite installation guidance from "included with pymilvus" to explicit installation via pymilvus[milvus-lite] feature spec

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• Documentation-only change with no code or logic modifications
• Simple wording update to installation instructions

Poem

🐰 A note, revised with care so bright,
Installation paths made clear and right,
[milvus-lite]—the feature flag shines,
Guidance improved, between the lines,
Hopping forward with docs refined! 📚✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'doc: fix quickstart section for Milvus Lite' directly relates to the main change: updating README.md documentation to reflect that milvus-lite is now an optional dependency requiring pymilvus[milvus-lite] installation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6a15a08 and 725fdc1.

📒 Files selected for processing (1)

• README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Summary

🔇 Additional comments (1)

README.md (1)

36-40: Documentation accurately reflects optional Milvus Lite dependency.

The change correctly updates the installation guidance from implying Milvus Lite is included by default to explicitly instructing users to install via pymilvus[milvus-lite]. The example code remains valid and demonstrates the intended use case.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[mergify]

@nathan-weinberg Thanks for your contribution. Please submit with DCO, see the contributing guide https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md#developer-certificate-of-origin-dco.

[mergify]

@nathan-weinberg

Invalid PR Title Format Detected

Your PR submission does not adhere to our required standards. To ensure clarity and consistency, please meet the following criteria:

1. Title Format: The PR title must begin with one of these prefixes:

• feat: for introducing a new feature.
• fix: for bug fixes.
• enhance: for improvements to existing functionality.
• test: for add tests to existing functionality.
• doc: for modifying documentation.
• auto: for the pull request from bot.
• build(deps): for dependency updates from Dependabot.

2. Description Requirement: The PR must include a non-empty description, detailing the changes and their impact.

Required Title Structure:

[Type]: [Description of the PR]

Where Type is one of feat, fix, enhance, test or doc.

Example:

enhance: improve search performance significantly 

Please review and update your PR to comply with these guidelines.

[sre-ci-robot]

[ci-v2-notice]
Notice: We are gradually rolling out the new ci-v2 system.

• Legacy CI jobs remain unaffected, you can just ignore ci-v2 if you don't want to run it.
• Additional "ci-v2/*" checkers will run for this PR to ensure the new ci-v2 system is working as expected.
• For tests that exist in both v1 and v2, passing in either system is considered PASS.

To rerun ci-v2 checks, comment with:

• /ci-rerun-code-check // for ci-v2/code-check
• /ci-rerun-build // for ci-v2/build
• /ci-rerun-ut-integration // for ci-v2/ut-integration
• /ci-rerun-ut-go // for ci-v2/ut-go
• /ci-rerun-ut-cpp // for ci-v2/ut-cpp
• /ci-rerun-ut // for all ci-v2/ut-integration, ci-v2/ut-go, ci-v2/ut-cpp
• /ci-rerun-e2e-arm // for ci-v2/e2e-arm [master branch only]
• /ci-rerun-e2e-default // for ci-v2/e2e-default [master branch only]

If you have any questions or requests, please contact @zhikunyao.

[qodo-code-review]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Add pip install snippet Add a bash code block showing the pip install "pymilvus[milvus-lite]" command to clarify the installation process for Milvus Lite. README.md [36] -* You can also try Milvus Lite for quickstart by installing `pymilvus[milvus-lite]`. To create a local vector database, simply instantiate a client with a local file name for persisting data: +* You can also try Milvus Lite for quickstart by installing `pymilvus[milvus-lite]` via: + ```bash + pip install "pymilvus[milvus-lite]" + ``` + To create a local vector database, simply instantiate a client with a local file name for persisting data: Apply / Chat Suggestion importance[1-10]: 6 __ Why: The suggestion improves the documentation by adding an explicit, copy-pasteable command, which enhances user experience and reduces the chance of installation errors.	Low
Update

[czs007]

/lgtm

[sre-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: czs007, nathan-weinberg

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [czs007]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[czs007]

@nathan-weinberg thanks!