Skip to content

[Feature]: Documentation on the ML model #125

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

Closed
1 task done
wincowgerDEV opened this issue Mar 6, 2023 · 1 comment
Closed
1 task done

[Feature]: Documentation on the ML model #125

wincowgerDEV opened this issue Mar 6, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation reviewer comment feedback from manuscript reviewers, should be prioritized

Comments

@wincowgerDEV
Copy link
Collaborator

Guidelines

  • I agree to follow this project's Contributing Guidelines.

Description

Reviewer said: To be clear, I'm not necessarily advocating for this as an addition to the GUI - the reason I brought it up was more around trying to figure out the value proposition of the UI itself and whether it was providing something that couldn't be done in a simpler way, and it sounds like the UI is important to make CV tools accessible to researchers. Integration with programable interfaces could still be valuable though (at the very least, I'd imagine it would be a good idea for the model to be available directly and not just via UI).

Problem

Some people likely want to use the model without the tool.

Proposed Solution

Add documentation about how to use the model without the tool or at least where it is.

Alternatives Considered

Assume people find the ML without documentation.

@wincowgerDEV wincowgerDEV added the enhancement New feature or request label Mar 6, 2023
@epierotti3 epierotti3 added documentation Improvements or additions to documentation reviewer comment feedback from manuscript reviewers, should be prioritized and removed enhancement New feature or request labels Apr 5, 2023
@epierotti3 epierotti3 added this to the Complete Manuscript milestone Apr 5, 2023
@epierotti3 epierotti3 moved this to To-Do in TrashAI Apr 5, 2023
@epierotti3 epierotti3 moved this from To-Do to In Progress in TrashAI Apr 5, 2023
@wincowgerDEV
Copy link
Collaborator Author

I think this should be part of a much longer-term vision for the tool. Closing for now and will let reviewers know this isn't intended at this time.

@github-project-automation github-project-automation bot moved this from In Progress to Done in TrashAI May 16, 2023
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 reviewer comment feedback from manuscript reviewers, should be prioritized
Projects
Status: Done
Development

No branches or pull requests

2 participants