Document the API

[TimZaman]

Hi guys. Currently the API functionality can only be browser by reading through the code. There is no overview of any kind, although the API functionality is, of course- and as intended, very neat.
I remember that before realizing there was an open API at all, I found something in a tutorial along the lines of:
curl localhost:5000/models/images/generic/infer_many.json (...)
One can never know about the API and its functionality without going through all the source code, therefore I think it's nice at least have a concise list-ish overview of all the routes and the potential arguments.

[gheinrich]

I totally agree! I have long intended to write a tutorial with full examples of how you can create datasets and models and do inference using the API but never got around to doing it. Also, I was planning to change some of the API in #616 so I found it convenient to have it undocumented at the time :-)

We used to have auto-generated API docs in https://github.com/NVIDIA/DIGITS/blob/v2.2.1/docs/API.md but this was removed. It might be worth improving the inline doc and resurrecting this auto-documentation.

[TimZaman]

That in-line doclooks great. Maybe resurrect that phoenix?

On Tue, Jun 7, 2016 at 10:46 AM, Greg Heinrich notifications@github.com
wrote:

I totally agree! I have long intended to write a tutorial with full
examples of how you can create datasets and models and do inference using
the API but never got around to doing it. Also, I was planning to change
some of the API in #616 #616 so I
found it convenient to have it undocumented at the time :-)

We used to have auto-generated API docs in
https://github.com/NVIDIA/DIGITS/blob/v2.2.1/docs/API.md but this was
removed. It might be worth improving the inline doc and resurrecting this
auto-documentation.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#814 (comment), or mute
the thread
https://github.com/notifications/unsubscribe/AHXSRHIJKA0jZ3eT2m7kfbTaR-Dy-Y6Hks5qJS_4gaJpZM4IvqTJ
.

[lukeyeager]

I removed Flask-Autodoc when adding soft login functionality. See #463 (comment).

I couldn't find a way to order the decorators on views properly so that Flask-Autodoc could still find the filename including the function. But we could probably just give up on that feature (even though it was kinda cool).

[gheinrich]

Hello I have pushed #964 to help there. It is not a proper API reference but it shows examples of how to use the API. Writing a detailed documentation would be difficult sine most of the magic is in the form fields, which aren't easy to add to the inline documentation.