milvus-io / pymilvus

Python SDK for Milvus.
Apache License 2.0
978 stars 312 forks source link

[QUESTION] Outdated documentation for pymilvus #598

Open tanzeyy opened 3 years ago

tanzeyy commented 3 years ago

pymilvus version: 2.0.0rc1

Currently the docs are outdated, for example, in the tutorial, the following code snippets no longer work: 图片 and will raise following error: 图片

Obviously these are due to the API mismatch, and I could only look into the code to find the correct way to use it. However there are still lots of missing in the function doc, for example, in link, the following doc is outdated, too.

        :type  fields: dict
            ` {"fields": [
                    {"field": "A", "type": DataType.INT32}
                    {"field": "B", "type": DataType.INT64},
                    {"field": "C", "type": DataType.FLOAT},
                    {"field": "Vec", "type": DataType.FLOAT_VECTOR,
                     "params": {"dim": 128}}
                ],

After test I found the "field" should be "name" and the "is_primary" key must be specified, like the following:

collection_name = 'demo_1'
fields = {
    "fields": [
        {"name": "A", "type": DataType.INT64, "is_primary": True},
        {"name": "Vec", "type": DataType.FLOAT_VECTOR, "params": {"dim": 200}}
    ],
    'auto_id': True
}
client.create_collection(collection_name, fields)

There are many errors like this, Milvus is a great project:muscle: and we hope you guys will soon fix it:heart:.

XuanYang-cn commented 3 years ago

@tanzeyy Thanks, we'll fix it soon.

Also, it's warmly welcomed if you could fix some of the bugs and fire a PR to us. We're proud to have brilliant people in our community.

We also have a slack channel #py-milvus, many pymilvus-orm developers and users are in the channel. It's very active and you are able to communicate with us on all sorts of things concerning pymilvus-orm, welcome to join the channel :smile:

narayananveswar commented 6 months ago

@XuanYang-cn Hai I am just start with my open source contributions. I have worked with Milvus as part of a project. I have a basic understanding of it. will this be a right place to start? If so what am I supposed to do.