Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[QUESTION] Outdated documentation for pymilvus #598

Open
tanzeyy opened this issue Jul 6, 2021 · 2 comments
Open

[QUESTION] Outdated documentation for pymilvus #598

tanzeyy opened this issue Jul 6, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@tanzeyy
Copy link

tanzeyy commented Jul 6, 2021

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
Copy link
Contributor

@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 😄

@XuanYang-cn XuanYang-cn added the documentation Improvements or additions to documentation label Jul 7, 2021
@narayananveswar
Copy link

narayananveswar commented Feb 28, 2024

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants