Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@kvarada
kvarada committed Sep 4, 2024
1 parent ee67398 commit 6304d13
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 10 deletions.
6 changes: 3 additions & 3 deletions README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,7 @@ <h2>Deliverable due dates (tentative)<a class="headerlink" href="#deliverable-du
<tr class="row-odd"><td><p>Syllabus quiz</p></td>
<td><p>Sept 19, 11:59 pm</p></td>
<td><p><a class="reference external" href="https://us.prairielearn.com/pl/course_instance/163899/assessment/2451488">PrairieLearn</a></p></td>
<td><p><a class="reference external" href="https://canvas.ubc.ca/courses/149122">Canvas</a></p></td>
<td><p><a class="reference external" href="https://us.prairielearn.com/pl/course_instance/163899/assessment/2451488">PrairieLearn</a></p></td>
</tr>
<tr class="row-even"><td><p>hw2</p></td>
<td><p>Sept 16, 11:59 pm</p></td>
Expand Down Expand Up @@ -497,8 +497,8 @@ <h2>Deliverable due dates (tentative)<a class="headerlink" href="#deliverable-du
</tr>
<tr class="row-even"><td><p><strong>Final exam</strong></p></td>
<td><p>TBA</p></td>
<td><p>PrairieLearn (in person)</p></td>
<td><p>PrairieLearn (in person)</p></td>
<td><p>PrairieLearn (CBTF, in person)</p></td>
<td><p>PrairieLearn (CBTF, in person)</p></td>
</tr>
</tbody>
</table>
Expand Down
4 changes: 2 additions & 2 deletions _sources/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Usually the homework assignments will be due on Mondays (except next week) and w
| Assessment | Due date | Where to find? | Where to submit? |
|----------------|-----------------------|------------------------------------------------------------------------------------|-------------------------------------------------------|
| hw1 | Sept 09, 11:59 pm | [Github repo](https://github.com/new?template_name=hw1&template_owner=ubc-cpsc330) | [Gradescope](https://www.gradescope.ca/courses/18608) |
| Syllabus quiz | Sept 19, 11:59 pm | [PrairieLearn](https://us.prairielearn.com/pl/course_instance/163899/assessment/2451488) | [Canvas](https://canvas.ubc.ca/courses/149122) |
| Syllabus quiz | Sept 19, 11:59 pm | [PrairieLearn](https://us.prairielearn.com/pl/course_instance/163899/assessment/2451488) | [PrairieLearn](https://us.prairielearn.com/pl/course_instance/163899/assessment/2451488) |
| hw2 | Sept 16, 11:59 pm | Github repo[](https://github.com/new?template_name=hw2&template_owner=ubc-cpsc330) | [Gradescope](https://www.gradescope.ca/courses/18608) |
| hw3 | Oct 01, 11:59 pm | Github repo[](https://github.com/new?template_name=hw3&template_owner=ubc-cpsc330) | [Gradescope](https://www.gradescope.ca/courses/18608) |
| hw4 | Oct 07, 11:59 pm | Github repo[](https://github.com/new?template_name=hw4&template_owner=ubc-cpsc330) | [Gradescope](https://www.gradescope.ca/courses/18608) |
Expand All @@ -49,7 +49,7 @@ Usually the homework assignments will be due on Mondays (except next week) and w
| hw7 | November 18, 11:59 pm | Github repo[](https://github.com/new?template_name=hw7&template_owner=ubc-cpsc330) | [Gradescope](https://www.gradescope.ca/courses/18608) |
| hw8 | November 25, 11:59 pm | Github repo[](https://github.com/new?template_name=hw8&template_owner=ubc-cpsc330) | [Gradescope](https://www.gradescope.ca/courses/18608) |
| hw9 | December 05, 11:59 pm | Github repo[](https://github.com/new?template_name=hw9&template_owner=ubc-cpsc330) | [Gradescope](https://www.gradescope.ca/courses/18608) |
| **Final exam** | TBA | PrairieLearn (in person) | PrairieLearn (in person) |
| **Final exam** | TBA | PrairieLearn (CBTF, in person) | PrairieLearn (CBTF, in person) |

## Lecture schedule (tentative)

Expand Down
18 changes: 17 additions & 1 deletion _sources/docs/homework_instructions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,27 @@ Here are the steps to create a repository for the released homework assignment.

When you're ready to submit your assignment, make sure all your work in the Jupyter Notebook is saved, all changes in the repository are committed, and you've pushed up to GitHub.

To submit your work you must **submit your final version of the notebook to [Gradescope](https://www.gradescope.ca)** where it will be graded.
### Preparation

1. Run all cells in your notebook to make sure there are no errors by running all cells: `Kernel -> Restart Kernel and Clear All Outputs` and then `Run -> Run All Cells`.

1. Notebooks with cell execution numbers out of order or not starting from “1” will have marks deducted. Notebooks without the output displayed may not be graded at all (because we need to see the output in order to grade your work).

### Submitting on Gradescope

1. Upload the assignment using Gradescope’s drag and drop tool. Make sure to access Gradescope via Canvas. Check out this [Gradescope Student Guide](https://lthub.ubc.ca/guides/gradescope-student-guide/) if you need help with your Gradescope submission.

1. Make sure that the plots and output are rendered properly in your submitted files.

1. If the `.ipynb` file is too big and doesn’t render on Gradescope, also upload a `pdf` or `html` in addition to the `.ipynb file`. If the `pdf` or `html` also fail to render on Gradescope, please create two files for your homework (e.g., `hw6a.ipynb` with Exercise 1 and `hw6b.ipynb` with Exercises 2 and 3) and include these two files in your repository.

You must **submit your final version of the notebook to [Gradescope](https://www.gradescope.ca)** where it will be graded.

Here is a video that shows you the process you'll be following (from a different course):

<div class="container youtube">
<iframe class="responsive-iframe" src="https://player.vimeo.com/video/1006094160?badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen style="position:absolute;top:0;left:0;width:100%;height:100%;" title="Submit GitHub Repository on Gradescope"></iframe><script src="https://player.vimeo.com/api/player.js"></script>
</div>

Once you submit to Gradescope, you should go there and ensure your assignment is there as expected and all the output and plots are rendered properly.

Expand Down
31 changes: 28 additions & 3 deletions docs/homework_instructions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,11 @@ <h2> Contents </h2>
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#accessing-homework-assignments">Accessing homework assignments</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#use-our-template-to-create-a-repository">Use our template to create a repository</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#how-to-submit">How to submit</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#how-to-submit">How to submit</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#preparation">Preparation</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#submitting-on-gradescope">Submitting on Gradescope</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#additional-submission-instructions">Additional submission instructions</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datasets">Datasets</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#report-format">Report format</a></li>
Expand Down Expand Up @@ -405,12 +409,29 @@ <h2>Use our template to create a repository<a class="headerlink" href="#use-our-
<section id="how-to-submit">
<h2>How to submit<a class="headerlink" href="#how-to-submit" title="Link to this heading">#</a></h2>
<p>When you’re ready to submit your assignment, make sure all your work in the Jupyter Notebook is saved, all changes in the repository are committed, and you’ve pushed up to GitHub.</p>
<p>To submit your work you must <strong>submit your final version of the notebook to <a class="reference external" href="https://www.gradescope.ca">Gradescope</a></strong> where it will be graded.</p>
<section id="preparation">
<h3>Preparation<a class="headerlink" href="#preparation" title="Link to this heading">#</a></h3>
<ol class="arabic simple">
<li><p>Run all cells in your notebook to make sure there are no errors by running all cells: <code class="docutils literal notranslate"><span class="pre">Kernel</span> <span class="pre">-&gt;</span> <span class="pre">Restart</span> <span class="pre">Kernel</span> <span class="pre">and</span> <span class="pre">Clear</span> <span class="pre">All</span> <span class="pre">Outputs</span></code> and then <code class="docutils literal notranslate"><span class="pre">Run</span> <span class="pre">-&gt;</span> <span class="pre">Run</span> <span class="pre">All</span> <span class="pre">Cells</span></code>.</p></li>
<li><p>Notebooks with cell execution numbers out of order or not starting from “1” will have marks deducted. Notebooks without the output displayed may not be graded at all (because we need to see the output in order to grade your work).</p></li>
</ol>
</section>
<section id="submitting-on-gradescope">
<h3>Submitting on Gradescope<a class="headerlink" href="#submitting-on-gradescope" title="Link to this heading">#</a></h3>
<ol class="arabic simple">
<li><p>Upload the assignment using Gradescope’s drag and drop tool. Make sure to access Gradescope via Canvas. Check out this <a class="reference external" href="https://lthub.ubc.ca/guides/gradescope-student-guide/">Gradescope Student Guide</a> if you need help with your Gradescope submission.</p></li>
<li><p>Make sure that the plots and output are rendered properly in your submitted files.</p></li>
<li><p>If the <code class="docutils literal notranslate"><span class="pre">.ipynb</span></code> file is too big and doesn’t render on Gradescope, also upload a <code class="docutils literal notranslate"><span class="pre">pdf</span></code> or <code class="docutils literal notranslate"><span class="pre">html</span></code> in addition to the <code class="docutils literal notranslate"><span class="pre">.ipynb</span> <span class="pre">file</span></code>. If the <code class="docutils literal notranslate"><span class="pre">pdf</span></code> or <code class="docutils literal notranslate"><span class="pre">html</span></code> also fail to render on Gradescope, please create two files for your homework (e.g., <code class="docutils literal notranslate"><span class="pre">hw6a.ipynb</span></code> with Exercise 1 and <code class="docutils literal notranslate"><span class="pre">hw6b.ipynb</span></code> with Exercises 2 and 3) and include these two files in your repository.</p></li>
</ol>
<p>You must <strong>submit your final version of the notebook to <a class="reference external" href="https://www.gradescope.ca">Gradescope</a></strong> where it will be graded.</p>
<p>Here is a video that shows you the process you’ll be following (from a different course):</p>
<div class="container youtube">
<iframe class="responsive-iframe" src="https://player.vimeo.com/video/1006094160?badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen style="position:absolute;top:0;left:0;width:100%;height:100%;" title="Submit GitHub Repository on Gradescope"></iframe><script src="https://player.vimeo.com/api/player.js"></script>
</div>
<p>Once you submit to Gradescope, you should go there and ensure your assignment is there as expected and all the output and plots are rendered properly.</p>
<p><strong>It is your responsibility to make sure your assignment is submitted properly and failure to do so will result in a deduction of marks.</strong></p>
</section>
</section>
<section id="additional-submission-instructions">
<h2>Additional submission instructions<a class="headerlink" href="#additional-submission-instructions" title="Link to this heading">#</a></h2>
<section id="datasets">
Expand Down Expand Up @@ -505,7 +526,11 @@ <h2>Citing sources<a class="headerlink" href="#citing-sources" title="Link to th
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#accessing-homework-assignments">Accessing homework assignments</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#use-our-template-to-create-a-repository">Use our template to create a repository</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#how-to-submit">How to submit</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#how-to-submit">How to submit</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#preparation">Preparation</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#submitting-on-gradescope">Submitting on Gradescope</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#additional-submission-instructions">Additional submission instructions</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datasets">Datasets</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#report-format">Report format</a></li>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit 6304d13

Please sign in to comment.