Implements/ports case synthetization (endpoint and command), closes #46

FG-AI4H-TG-Symptom / fgai4h-tg-symptom-assessment-mmvb-backend

A backend of a minimal minimal viable benchmark designed and developed by the members of the sub-group (topic group) “Symptom assessment”, which is the part of the ITU focus group “Artificial Intelligence for Health”

6 stars 4 forks source link

Implements/ports case synthetization (endpoint and command), closes #46 #54

Closed maccinza closed 4 years ago

maccinza commented 4 years ago

After a lot of digging around I couldn't find a simple way to set up everything needed for properly generating docs for the case-synthesizer endpoint. When you use the docs page and try to use the case synthesizer from there it works but the page shows a documentation error.

I would push this forward as it is for now as the feature and the endpoint work, so it is a matter of finding the right way (which has a good balance between automation and customization) for documenting stuff.

As briefly discussed on slack maybe https://drf-yasg.readthedocs.io/en/stable/index.html could give us that.

neopostmodern commented 4 years ago

sorry, i can't find the relevant code bits right now, here are some non-blocking thoughts:

it'd be nice if case sets were generated with human readable names "Synthesised case set with 50 cases (UUID-HERE)"
having the case-set generator generate batches of case-sets seems like an overkill to me, but as it doesn't have any obvious downsides (i can just hard-code it to 1 case set for now in the front-end) i don't see much need to change it
at the top of the API doc there are two errors which I think must have been introduced in this PR

maccinza commented 4 years ago

sorry, i can't find the relevant code bits right now, here are some non-blocking thoughts:

it'd be nice if case sets were generated with human readable names "Synthesised case set with 50 cases (UUID-HERE)"

having the case-set generator generate batches of case-sets seems like an overkill to me, but as it doesn't have any obvious downsides (i can just hard-code it to 1 case set for now in the front-end) i don't see much need to change it

at the top of the API doc there are two errors which I think must have been introduced in this PR

The error is probably related to the lack of a schema to reference when implementing the list of URLs you requested for the cases generator (I believe I mentioned it on a comment above). Will try to address the other comments later today.