code4sac/trash-ai

[Feature]: Document model/build tools

Closed this issue · 0 comments

Guidelines

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

Description

The current model/build folder is severely lacking in documentation
https://github.com/code4sac/trash-ai/tree/production/model/build.

This is just saying "run this file". It doesn't explain that Docker is needed to run it, and it doesn't explain what is going on when you run the file. It also doesn't explain what the two different notebooks are in that folder and the purpose of them.

Problem

https://github.com/code4sac/trash-ai/tree/production/model/build does not provide enough context to understand what the code in this folder does.

Proposed Solution

Build out the readme in this file to explain exactly what the purpose of this folder is, what gets run in the folder, and what the requirements are to run it.

It would also be great to link to this file on the main readme page.

Alternatives Considered

Don't add documentation and let people figure it out for themselves :/.