Skip to content

Commit 856dffa

Browse files
authored
updated readme so its more useful
1 parent 2e8cce4 commit 856dffa

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
11
# Tutorials in machine learning for physics education research
2-
This is a repo for the quantitative analysis group, it contains notebooks demonstrating various methods of research and visualization
2+
This is a repo has a number of tutorials that are meant to help PER researchers get started with machine learning projects. It assumes that you have an existing understanding of python syntax. Learning goals for these tutorials are:
3+
4+
1. Have an understanding of different ways to explore data using the `pandas` and `matplotlib` libraries
5+
2. Become familiar with the `model->train->score` paradigm of `sklearn`
6+
3. Have an understanding of the code implementations of `sklearn` for different machine learning tasks (namely regression, classification, and clustering)
7+
4. Have an understanding of how to connect a sql database to a `pandas` dataframe
8+
5. Have an understanding of the `train_test_split` paradigm of `sklearn`
9+
6. Have an understanding of regression model evaluation
10+
7. Have an understanding of classification model evaluation
11+
12+
This collection of tutorials should not be considered exhaustive of machine learning topics, nor is it meant to produce a deep conceptual understanding of how the algorithms work. Instead it is meant for onboarding researchers unfamiliar with the basics of conducting applied machine learning research in PER via workshops or self learning.
13+
14+
The format of all of the notebooks is:
15+
16+
`exercise`
17+
`exercise_with_solutions`
18+
19+
Please do not feel you cannot look at the solutions and must figure it out on yourself. It is totally acceptable to look at the solutions to figure your way out. But it should not be copy and paste code, the goal is to develop understanding of what each step is doing.
320

421
# Rules for submitting
522

623
1. When committing notebooks please include descriptions of how to use them in the notebooks.
724
2. R and Python notebooks are accepted. Please use Python 3.x.
8-
3. Submit R notebooks to the R folder and Python notebooks to the python folder.
9-
4. If writing Python Please follow PEP-8 where possible. More information on [PEP-8 can be found here](https://www.python.org/dev/peps/pep-0008/)
10-
5. If your Python notebook has library requirements please update the environment.yml file to reflect the new requirements.
11-
6. For new notebooks please create a branch with a relevant title and commit and then merge with the master. This will avoid conflicts for people working on different topics.
25+
3. If writing Python Please follow PEP-8 where possible. More information on [PEP-8 can be found here](https://www.python.org/dev/peps/pep-0008/)
26+
4. If your Python notebook has library requirements please update the environment.yml file to reflect the new requirements.
27+
5. For new notebooks please create a branch with a relevant title and commit and then merge with the master. This will avoid conflicts for people working on different topics.
1228

1329
If you have questions people are always available on Slack!

0 commit comments

Comments
 (0)