code4sac/trash-ai

[Feature]: Documentation on the ML model

Closed this issue · 1 comments

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.

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.