update readme #219
Merged
update readme #219
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
ammkk
commented
Jul 22, 2024
| ], | ||
| "attributes": [ | ||
| { | ||
| "type": "text", |
Author
There was a problem hiding this comment.
必須のパラメータであり、現状のサンプルコードではエラーが出てしまう。
ctakigawa
reviewed
Jul 22, 2024
README.md
Outdated
| } | ||
| ``` | ||
|
|
||
| If you would like to create with classification type annotations, please pass empty points and value of the annotation named 'classification'. |
There was a problem hiding this comment.
create の後に目的語(a new dataset objectとか)あった方が良さそうです！
If you would like to create a new dataset object with classification type annotations, ~~
ctakigawa
reviewed
Jul 22, 2024
README.md
Outdated
Comment on lines
2593
to
2620
| ``` | ||
|
|
||
| If you would like to create with classification type annotations, please pass empty points and value of the annotation named 'classification'. | ||
|
|
||
| ```python | ||
| dataset_object = client.create_dataset_object( | ||
| dataset="YOUR_DATASET_NAME", | ||
| name="brushwood_dog.jpg", | ||
| file_path="./brushwood_dog.jpg", | ||
| tags=["dog"], # max 5 tags per dataset object. | ||
| licenses=["MIT", "my-license"], # max 10 licenses per dataset object | ||
| annotations=[ | ||
| { | ||
| "type": "classification", | ||
| "value": "classification", | ||
| "points": [], | ||
| "attributes": [ | ||
| { | ||
| "type": "text", | ||
| "value": "Scottish field", | ||
| "key": "kind" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| ) | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Response Dataset Objectのセクションより前にあった方が良さそうかと思いましたがいかがでしょうか？
ctakigawa
approved these changes
Jul 22, 2024
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.
背景
create_dataset_objectで分類アノテーションを付与する際のパラメータについてREADMEに記載が無かった。
対応
分類アノテーションを付与する時のパラメータについてREADMEに記載した。