Title (Scenario - Topic - Teaching Content)
Table of Contents
A few sentences providing a basic introduction to the notebook content. The primary purpose of the introduction is to explain to the user what he will learn in the notebook and to give an example how the knowledge can be used.
Describe the requirements necessary to understand the contents of the notebook. If possible, appropriate sources should be provided to learn these requirements, especially if another deep.TEACHING notebook teaches this content.
With the deep.TEACHING convention, all python modules needed to run the notebook are loaded centrally at the beginning.
# Python Standard Library import os from collections import OrderedDict, Counter # External Modules import tensorflow import numpy as np import matplotlib.pyplot as plt import deep_teaching_commons
All data used should be provided here. This includes data collection and preparation so that the notebook can be run without further data processing. We advice to give a glimpse of the full processed data to the user at the end of that cell.
By deep.TEACHING convention the default folder for data used within deep.TEACHING notebooks is
'~/deep.TEACHING/data'. You are welcome to contribute to deep.TEACHING_Commons project, where we try to centralize sourcecode that is related to the notebooks e.g., data processing or automated reviewing of exercises.
This area is reserved for the actual teaching content. Give this section a suitable title, for example, based on the notebook title and feel free to structure it further with appropriated subsections.
Provide the user with the opportunity to reinforce what they have learned through exercises. We distinguish between two categories of exercises. Exercises with explanations and partially given solutions that help users when necessary and exercises without any support. Even if you do not provide an explanation to your practice solution, it may be useful if there is some form of automated solution control, e.g., via the deep.TEACHING_Commons project. It is a good idea to offer several exercises on a topic.
Citation of literature is based on the IEEE editorial style manual. Only in the case of in-text citations we deviate from these specifications. Instead of a reference number we use the first three letters of the surname of the main author and the last two numbers of the publication year. An example is given below.
Notebook License (CC-BY-SA 4.0)
The following license applies to the complete notebook, including code cells. It does however not apply to any referenced external media (e.g., images).
by Author (provide a link if possible)
is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
Based on a work at https://gitlab.com/deep.TEACHING.
Code License (MIT)
The following license only applies to code cells of the notebook.
Copyright 2018 Author
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.