I looked through the first draft of the notebook. Great job so far, thank you so much for all the work!
Before I give more in-depth cell-by-cell review, there are a few general comments:
[ ] Please add markdown cells to the notebook that explains what's going on and guide students throughout the notebook.
You can take a look at our content guidelines here, but the basic idea is that students should be able to open your notebook in the future without watching the session and understand what’s going on. There are a few examples of using markdown cells in the article to drive the narrative of the training. Please take a look!
Here are a few more examples to get you started:
Adel's amazing training on machine learning with scikit-learn.
Notice how he uses text throughout the training to drive the narrative. For example, here:
We run the code, critically examine the result, and make an observation (that will be later addressed in the training)
Or here:
He gives a background on what we're about to do, and also a brief overview of the function.
[ ] *Make sure that code comments (together with markdown cells) provide students with enough context to be able to write the code themselves.
The student notebook will be pretty much the solution notebook with all code except the imports removed. On the other hand, students are expected to be able to follow the notebook by themselves. So, the code comments should provide a little more detail about the code that the student is supposed to write.
Here is an example from the scikit-learn training linked above:
Solution notebook:
Student notebook
This will help not only students but you as well, as you will be working from the "blank" student notebook in the session.
I'll move the due dates in Asana by a day as these changes might require more time. Please let me know if you have any questions or concerns!
Hi @LisaStuart5678 ,
I looked through the first draft of the notebook. Great job so far, thank you so much for all the work!
Before I give more in-depth cell-by-cell review, there are a few general comments:
You can take a look at our content guidelines here, but the basic idea is that students should be able to open your notebook in the future without watching the session and understand what’s going on. There are a few examples of using markdown cells in the article to drive the narrative of the training. Please take a look!
Here are a few more examples to get you started:
Or here:
He gives a background on what we're about to do, and also a brief overview of the function.
Some here are some other examples: Machine learning with XGBoost, Brand Analysis using Social Media in R
The student notebook will be pretty much the solution notebook with all code except the imports removed. On the other hand, students are expected to be able to follow the notebook by themselves. So, the code comments should provide a little more detail about the code that the student is supposed to write.
Here is an example from the scikit-learn training linked above:
Solution notebook:
Student notebook
This will help not only students but you as well, as you will be working from the "blank" student notebook in the session.
I'll move the due dates in Asana by a day as these changes might require more time. Please let me know if you have any questions or concerns!