Add documentation - Githubissues

solsylph / Debate-Chatbot

0 stars 1 forks source link

Add documentation #9

Closed 11acc closed 5 months ago

11acc commented 6 months ago

From Miguel's feedback: "There are no notebooks explaining what the team is doing, no README, there is no explanation of what the team did or why they chose the technologies they chose."

Goals for this issue:

README explaining what we are doing
Notebook about the technologies we are using and why

As for "technologies":

Why are we using x, y, z models
Are we getting data from a specific place? Why?

solsylph commented 5 months ago

i'll work on this and focus on documentation over the next couple of days

solsylph commented 5 months ago

i have updated the readme and included the required specifications in the documentation. can be found in the docs folder.