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.

Sign up for GitHub

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

Jump to bottom

edit tutorial1&2 content #4

Merged
merged 2 commits into from
Nov 16, 2023
Merged

edit tutorial1&2 content #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd7f4a6
edit tutorial1&2 content
iamzoltan Nov 8, 2023
b8d5142
Process tutorial notebooks
actions-user Nov 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion tutorials/W1D1_Instructions/W1D1_Tutorial1.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,11 @@
"\n",
"- import template\n",
"- name course\n",
"- choose organization\n",
"- choose organization (owner)\n",
"- make it public\n",
"- wait\n",
"\n",
"**NOTE:** In order to create a repo under neuromatch, you will need to be a part of the organization. Be careful you do not create the repo under your username. If you need to be added to the org, you can message Konstantine Tsafatinos in the technical channel on slack.\n",
"<p align='center'><img src='https://github.com/neuromatch/course-content-template/blob/main/tutorials/static/new-course.gif?raw=True' alt='create new course gif'/></p>"
]
},
Expand Down
24 changes: 13 additions & 11 deletions tutorials/W1D1_Instructions/W1D1_Tutorial2.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@
"source": [
"## Section 2.1: Creating a PR\n",
"\n",
"Once you have push the work on your new branch, you can create a PR onto the main branch. **NOTE**: This will trigger the processing workflow for the course content.\n",
"Once you have pushed the work on your new branch, you can create a PR onto the main branch. **NOTE**: This will trigger the processing workflow for the course content.\n",
"\n",
"Create a pull request:\n",
"\n",
Expand All @@ -166,7 +166,7 @@
"\n",
"<p align='center'><img src='https://github.com/neuromatch/course-content-template/blob/main/tutorials/static/process-notebook.gif?raw=True' alt='process notebook gif'/></p>\n",
"\n",
"The process notebook workflow will automatically get triggered once a pull request is made to the main branch. It will create the student, instructor and solutions directories, verify the exercises, and prepare the content for the publish workflow. You do **not** need to create or touch the aforementioned folders. All your work should be done on the jupyter notebooks. Remember to restart the kernel and clear your output, if you do not, the process notebooks workflow will throw and error."
"The process notebook workflow will automatically get triggered once a pull request is made to the main branch. It will create the student, instructor and solutions directories, verify the exercises, and prepare the content for the publish workflow. You do **not** need to create or touch the aforementioned folders. All your work should be done on the jupyter notebooks. Remember to restart the kernel and clear your output, if you do not, the process notebooks workflow will throw an error."
]
},
{
Expand Down Expand Up @@ -209,7 +209,7 @@
"\n",
"The workflows and processing scripts actively make use of predefined tags to determine how to process the cell. There are tags for video embeddeing, slide embedding, titles, exercises and solutions, etc. It is very important these instructions are followed **exactly**! Any deviations will break the pipeline. More details about the tags and how to use them can be found in W1D2_Tutorial1.ipynb of the template notebook.\n",
"\n",
"**NOTE**: Please read the details found in the template very carefully. Specifically the section on exercises and solutions. You need to be precises. We have a verify exercises script that will fail if you deviate from the instructions. For example, the comments in the cells for the exercises and solutions grouping need to be **EXACT**. See below:\n",
"**NOTE**: Please read the details found in the template very carefully. Specifically the section on exercises and solutions. You need to be precise. We have a script to verify exercises that will fail if you deviate from the instructions. For example, the comments in the cells for the exercises and solutions grouping need to be **EXACT**. See below:\n",
"\n",
"Exercise:\n",
"\n",
Expand All @@ -233,7 +233,9 @@
"&emsp; return x\n",
"\n",
"\n",
"This will fail because \"comments\" is singular in the comments of the solution cell. These checks are in place to ensure the exercise and corresponding solution cells are appropriately matched and coupled. This comment rule applies to **all** comments in the exercise/solution cells."
"This will fail because \"comments\" is singular in the comments of the solution cell. These checks are in place to ensure the exercise and corresponding solution cells are appropriately matched and coupled. This comment rule applies to **all** comments in the exercise/solution cells.\n",
"\n",
"The above is not an exhaustive list of the cell tags, it is simply a highlight of something that can go wrong that is easy to miss. Please find the details of all tags [here](https://neuromatch.github.io/course-content-template/tutorials/W1D2_Template/student/W1D2_Tutorial1.html). "
]
},
{
Expand All @@ -256,11 +258,11 @@
"\n",
"We recommend using .png or .gif file extensions.\n",
"\n",
"**NOTE**: This will not show up in your local development environment until the images are add to the main branch on github. As you can see from the above URL, it is pointing to the main branch of a github repository. If you would like to test it locally, you can use this:\n",
"**NOTE**: This will not show up in your local development environment until the images are added to the main branch on github. As you can see from the above URL, it is pointing to the main branch of a github repository. If you would like to test it locally, you can use this:\n",
"\n",
"\\<p align='center'>\\<img src='../static/your_file_name.png' alt='image desctiption'/>\\</p>\n",
"\n",
"Remember to change the source back to the github url before push your changes!"
"Remember to change the source back to the github url before pushing your changes!"
]
},
{
Expand All @@ -273,7 +275,7 @@
"\n",
"# Section 4: Add Content to the materials.yml File\n",
"\n",
"The materials.yml file is used in our scripts to help very links, populate the books, and create our table of contents. Be sure to **precisely** follow the structure outlined in the file. If you look at the materials.yml file for this template notebook, you will see the structure laid out in order for this book to properly build. There are comments in the file to further explain all the fields you will need to use. Here is an overview of the structure:\n",
"The materials.yml file is used in our scripts to help verify links, populate the books, and create our table of contents. Be sure to **precisely** follow the structure outlined in the file. If you look at the materials.yml file for this template notebook, you will see the structure laid out in order for this book to properly build. There are comments in the file to further explain all the fields you will need to use. Here is an overview of the structure:\n",
"\n",
"- day: W1D1\n",
" - category: Course Content Template Instructions \n",
Expand Down Expand Up @@ -302,7 +304,7 @@
" - title: TA\n",
" - tutorials: 1\n",
" \n",
"Remember to create one grouping of the above content per day and be sure to make the number of tutorials."
"Remember to create one grouping of the above content per day and be sure to set the number of tutorials."
]
},
{
Expand All @@ -317,7 +319,7 @@
"There are two main workflows used to build the notebooks:\n",
"- notebook-pr (automatically triggered when a PR is made onto the main repo)\n",
"- publish-book (this needs to be manually triggered by navigating to the github actions tab. See Below)\n",
"Each workflow involves building python environments and running python scripts on github's servers, and then automatically creating the appropriate commits and pushes on github. The scripts handle notbeook processing, verification and html generation. After the publish-book workflow is complete, it pushes the generated html files into the gh-pages branch (it creates one if it does not exist). This branch is not to be touched and is automatically taken care of for us. All we need to do is change our pages settings in github settings to use the gh-pages branch instead of mean. See Below.\n",
"Each workflow involves building python environments and running python scripts on github's servers, and then automatically creating the appropriate commits and pushes on github. The scripts handle notbeook processing, verification and html generation. After the publish-book workflow is complete, it pushes the generated html files into the gh-pages branch (it creates one if it does not exist). This branch is not to be touched and is automatically taken care of for us. All we need to do is change our pages settings under github settings to use the gh-pages branch instead of main. See Below.\n",
"\n",
"Trigger publish-book:\n",
"<p align='center'><img src='https://github.com/neuromatch/course-content-template/blob/main/tutorials/static/publish-book.gif?raw=True' alt='publish book gif'/></p>\n",
Expand All @@ -335,15 +337,15 @@
"---\n",
"# Summary\n",
"\n",
"Congrats! You have now know:\n",
"Congrats! You now know:\n",
"\n",
"1. how and where to create new content\n",
"2. how to follow our naming convention\n",
"3. how to prepare the notebooks for our pipeline\n",
"4. how to create branches and pull requests\n",
"5. the basics of our workflows using github actions\n",
"\n",
"Happy creating!"
"Happy content creating!"
]
}
],
Expand Down
3 changes: 2 additions & 1 deletion tutorials/W1D1_Instructions/instructor/W1D1_Tutorial1.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,11 @@
"\n",
"- import template\n",
"- name course\n",
"- choose organization\n",
"- choose organization (owner)\n",
"- make it public\n",
"- wait\n",
"\n",
"**NOTE:** In order to create a repo under neuromatch, you will need to be a part of the organization. Be careful you do not create the repo under your username. If you need to be added to the org, you can message Konstantine Tsafatinos in the technical channel on slack.\n",
"<p align='center'><img src='https://github.com/neuromatch/course-content-template/blob/main/tutorials/static/new-course.gif?raw=True' alt='create new course gif'/></p>"
]
},
Expand Down
24 changes: 13 additions & 11 deletions tutorials/W1D1_Instructions/instructor/W1D1_Tutorial2.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@
"source": [
"## Section 2.1: Creating a PR\n",
"\n",
"Once you have push the work on your new branch, you can create a PR onto the main branch. **NOTE**: This will trigger the processing workflow for the course content.\n",
"Once you have pushed the work on your new branch, you can create a PR onto the main branch. **NOTE**: This will trigger the processing workflow for the course content.\n",
"\n",
"Create a pull request:\n",
"\n",
Expand All @@ -166,7 +166,7 @@
"\n",
"<p align='center'><img src='https://github.com/neuromatch/course-content-template/blob/main/tutorials/static/process-notebook.gif?raw=True' alt='process notebook gif'/></p>\n",
"\n",
"The process notebook workflow will automatically get triggered once a pull request is made to the main branch. It will create the student, instructor and solutions directories, verify the exercises, and prepare the content for the publish workflow. You do **not** need to create or touch the aforementioned folders. All your work should be done on the jupyter notebooks. Remember to restart the kernel and clear your output, if you do not, the process notebooks workflow will throw and error."
"The process notebook workflow will automatically get triggered once a pull request is made to the main branch. It will create the student, instructor and solutions directories, verify the exercises, and prepare the content for the publish workflow. You do **not** need to create or touch the aforementioned folders. All your work should be done on the jupyter notebooks. Remember to restart the kernel and clear your output, if you do not, the process notebooks workflow will throw an error."
]
},
{
Expand Down Expand Up @@ -209,7 +209,7 @@
"\n",
"The workflows and processing scripts actively make use of predefined tags to determine how to process the cell. There are tags for video embeddeing, slide embedding, titles, exercises and solutions, etc. It is very important these instructions are followed **exactly**! Any deviations will break the pipeline. More details about the tags and how to use them can be found in W1D2_Tutorial1.ipynb of the template notebook.\n",
"\n",
"**NOTE**: Please read the details found in the template very carefully. Specifically the section on exercises and solutions. You need to be precises. We have a verify exercises script that will fail if you deviate from the instructions. For example, the comments in the cells for the exercises and solutions grouping need to be **EXACT**. See below:\n",
"**NOTE**: Please read the details found in the template very carefully. Specifically the section on exercises and solutions. You need to be precise. We have a script to verify exercises that will fail if you deviate from the instructions. For example, the comments in the cells for the exercises and solutions grouping need to be **EXACT**. See below:\n",
"\n",
"Exercise:\n",
"\n",
Expand All @@ -233,7 +233,9 @@
"&emsp; return x\n",
"\n",
"\n",
"This will fail because \"comments\" is singular in the comments of the solution cell. These checks are in place to ensure the exercise and corresponding solution cells are appropriately matched and coupled. This comment rule applies to **all** comments in the exercise/solution cells."
"This will fail because \"comments\" is singular in the comments of the solution cell. These checks are in place to ensure the exercise and corresponding solution cells are appropriately matched and coupled. This comment rule applies to **all** comments in the exercise/solution cells.\n",
"\n",
"The above is not an exhaustive list of the cell tags, it is simply a highlight of something that can go wrong that is easy to miss. Please find the details of all tags [here](https://neuromatch.github.io/course-content-template/tutorials/W1D2_Template/student/W1D2_Tutorial1.html). "
]
},
{
Expand All @@ -256,11 +258,11 @@
"\n",
"We recommend using .png or .gif file extensions.\n",
"\n",
"**NOTE**: This will not show up in your local development environment until the images are add to the main branch on github. As you can see from the above URL, it is pointing to the main branch of a github repository. If you would like to test it locally, you can use this:\n",
"**NOTE**: This will not show up in your local development environment until the images are added to the main branch on github. As you can see from the above URL, it is pointing to the main branch of a github repository. If you would like to test it locally, you can use this:\n",
"\n",
"\\<p align='center'>\\<img src='../static/your_file_name.png' alt='image desctiption'/>\\</p>\n",
"\n",
"Remember to change the source back to the github url before push your changes!"
"Remember to change the source back to the github url before pushing your changes!"
]
},
{
Expand All @@ -273,7 +275,7 @@
"\n",
"# Section 4: Add Content to the materials.yml File\n",
"\n",
"The materials.yml file is used in our scripts to help very links, populate the books, and create our table of contents. Be sure to **precisely** follow the structure outlined in the file. If you look at the materials.yml file for this template notebook, you will see the structure laid out in order for this book to properly build. There are comments in the file to further explain all the fields you will need to use. Here is an overview of the structure:\n",
"The materials.yml file is used in our scripts to help verify links, populate the books, and create our table of contents. Be sure to **precisely** follow the structure outlined in the file. If you look at the materials.yml file for this template notebook, you will see the structure laid out in order for this book to properly build. There are comments in the file to further explain all the fields you will need to use. Here is an overview of the structure:\n",
"\n",
"- day: W1D1\n",
" - category: Course Content Template Instructions \n",
Expand Down Expand Up @@ -302,7 +304,7 @@
" - title: TA\n",
" - tutorials: 1\n",
" \n",
"Remember to create one grouping of the above content per day and be sure to make the number of tutorials."
"Remember to create one grouping of the above content per day and be sure to set the number of tutorials."
]
},
{
Expand All @@ -317,7 +319,7 @@
"There are two main workflows used to build the notebooks:\n",
"- notebook-pr (automatically triggered when a PR is made onto the main repo)\n",
"- publish-book (this needs to be manually triggered by navigating to the github actions tab. See Below)\n",
"Each workflow involves building python environments and running python scripts on github's servers, and then automatically creating the appropriate commits and pushes on github. The scripts handle notbeook processing, verification and html generation. After the publish-book workflow is complete, it pushes the generated html files into the gh-pages branch (it creates one if it does not exist). This branch is not to be touched and is automatically taken care of for us. All we need to do is change our pages settings in github settings to use the gh-pages branch instead of mean. See Below.\n",
"Each workflow involves building python environments and running python scripts on github's servers, and then automatically creating the appropriate commits and pushes on github. The scripts handle notbeook processing, verification and html generation. After the publish-book workflow is complete, it pushes the generated html files into the gh-pages branch (it creates one if it does not exist). This branch is not to be touched and is automatically taken care of for us. All we need to do is change our pages settings under github settings to use the gh-pages branch instead of main. See Below.\n",
"\n",
"Trigger publish-book:\n",
"<p align='center'><img src='https://github.com/neuromatch/course-content-template/blob/main/tutorials/static/publish-book.gif?raw=True' alt='publish book gif'/></p>\n",
Expand All @@ -335,15 +337,15 @@
"---\n",
"# Summary\n",
"\n",
"Congrats! You have now know:\n",
"Congrats! You now know:\n",
"\n",
"1. how and where to create new content\n",
"2. how to follow our naming convention\n",
"3. how to prepare the notebooks for our pipeline\n",
"4. how to create branches and pull requests\n",
"5. the basics of our workflows using github actions\n",
"\n",
"Happy creating!"
"Happy content creating!"
]
}
],
Expand Down
3 changes: 2 additions & 1 deletion tutorials/W1D1_Instructions/student/W1D1_Tutorial1.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,11 @@
"\n",
"- import template\n",
"- name course\n",
"- choose organization\n",
"- choose organization (owner)\n",
"- make it public\n",
"- wait\n",
"\n",
"**NOTE:** In order to create a repo under neuromatch, you will need to be a part of the organization. Be careful you do not create the repo under your username. If you need to be added to the org, you can message Konstantine Tsafatinos in the technical channel on slack.\n",
"<p align='center'><img src='https://github.com/neuromatch/course-content-template/blob/main/tutorials/static/new-course.gif?raw=True' alt='create new course gif'/></p>"
]
},
Expand Down
Loading