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

Add request param descriptions and update Swagger models help text #20

Merged
merged 2 commits into from
Aug 20, 2018

Conversation

MLnick
Copy link
Contributor

@MLnick MLnick commented Aug 1, 2018

Added help text describing request params for model/predict in more detail.

Existing Swagger UI:

screen shot 2018-08-01 at 13 53 07

Now:

screen shot 2018-08-01 at 13 52 23

Also updated the description text for various fields in the Swagger models for responses.

Copy link

@gdequeiroz gdequeiroz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@ajbozarth ajbozarth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think changing label to class label is an interesting choice, but I'm fine with it. LGTM

@MLnick
Copy link
Contributor Author

MLnick commented Aug 7, 2018

@ptitzler ?

@autoih
Copy link

autoih commented Aug 7, 2018

Input:
Any limitation of the size of an input image? For example, should be larger than 50 x 50 pixels; otherwise there is no object can be detected. By contrast, what is the maximum size of an input image?

Output:
What kind of format will the metadata generate?

I am not sure the though is good for this. If not, please ignore it. Thank you!

Copy link
Contributor

@ptitzler ptitzler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit. Description/help text that forms a valid sentence should end with a period. (see help for detection_box) Not sure if there is a standard though.

@xwu0226
Copy link
Member

xwu0226 commented Aug 14, 2018

LGTM
@MLnick i think we can merge it. and let's assign tasks to other people to carry out the changes for all model repos.

@MLnick MLnick merged commit bdc08ad into master Aug 20, 2018
@MLnick MLnick deleted the swagger-help-doc branch August 20, 2018 12:01
@MLnick
Copy link
Contributor Author

MLnick commented Aug 20, 2018

@xwu0226 ok let's assign someone to roll similar changes out across models.

This was referenced Aug 20, 2018
xuhdev pushed a commit to xuhdev/MAX-Object-Detector that referenced this pull request Jun 16, 2020
Status badge and link to long running instance of the web app
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants