Skip to content
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

README Reading Material/References Section Documenting Classification Model Training Articles #93

Open
hewittk opened this issue Apr 28, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@hewittk
Copy link
Collaborator

hewittk commented Apr 28, 2021

Context and feature:
Two sources were used as part of the category frequency classification model's training on recognizing professional skills. These articles are linked here and here. These articles should be cited within the repository.

Proposed solution:
According to the professor, the best way to cite these would be by adding and citing them within a Reading Material or References section in the README. Adding such a section to the documentation will also likely be useful for any future enhancements that use web resources such as articles.

Useful resources:
There is an example of a Reading Material/References section in the README of the Ethical-CS facial recognition repository.

Additional context:
The category classification model was trained using questions and student responses in the lab reflections from the resources/sample_md_reflection folder of GatorMiner. Each question and response from an individual student's assignment was categorized into either technical skills, professional skills, and ethics, and be learned by the classification model as an example of its category. The above articles about professional skills were broken up by skill featured and fed to the model as strings of professional skills.

@hewittk hewittk added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Apr 28, 2021
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 enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant