admin/milvus
1
0
Fork 0
mirror of https://gitee.com/milvus-io/milvus.git synced 2025-12-28 14:35:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: fix quickstart section for Milvus Lite (#46474)

Browse Source 
### **User description**
As of https://github.com/milvus-io/pymilvus/pull/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


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



<details><summary><h3>File Walkthrough</h3></summary>

<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>README.md</strong><dd><code>Clarify Milvus Lite as
optional dependency</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
</dd></summary>
<hr>

README.md

<ul><li>Updated installation documentation to clarify that
<code>milvus-lite</code> is no <br>longer included by default<br> <li>
Changed wording from "includes Milvus Lite" to "can try Milvus Lite by
<br>installing <code>pymilvus[milvus-lite]</code>"<br> <li> Reflects the
breaking change from pymilvus PR #2976 where milvus-lite <br>became an
optional dependency</ul>


</details>


  </td>
<td><a
href="https://github.com/milvus-io/milvus/pull/46474/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>
</table></td></tr></tbody></table>

</details>

___



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

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

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Nathan Weinberg <nathan2@stwmd.net>
This commit is contained in:
Nathan Weinberg 2025-12-23 01:07:18 -06:00 committed by GitHub
parent 0a2f8d4f63
commit 9f63a5cf1a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -33,7 +33,7 @@ This installs `pymilvus`, the Python SDK for Milvus. Use `MilvusClient` to creat
from pymilvus import MilvusClient
```
* `pymilvus` also includes Milvus Lite for quickstart. 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]`. To create a local vector database, simply instantiate a client with a local file name for persisting data:
```python
client = MilvusClient("milvus_demo.db")