Skip to content

Formative assessment for manual editing #86

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

Open
alpha-beta-soup wants to merge 2 commits into
base: gh-pages
Choose a base branch
from
Open

Formative assessment for manual editing #86

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d6e2f9
commit formative assessment for manual editing
alpha-beta-soup Jun 2, 2021
ca1af95
commit formative assessment for manual editing
alpha-beta-soup Jun 2, 2021
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
20 changes: 19 additions & 1 deletion _episodes/01-introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ python plotcount.py isles.dat isles.png
python plotcount.py abyss.dat abyss.png

# This line is also commented out because it doesn't need to be rerun.
python zipf_test.py abyss.dat isles.dat > results.txt
#python zipf_test.py abyss.dat isles.dat > results.txt
~~~
{: .language-bash}

Expand All @@ -263,6 +263,24 @@ What we really want is an executable _description_ of our pipeline that
allows software to do the tricky part for us: figuring out what tasks need to
be run where and when, then perform those tasks for us.

> ## Thinking about updating results
>
> 1. Make some small adjustment to `plotcount.py` that changes how the information is presented in the graph (hint: just like how we earlier adjusted the `width`).
> 2. Run the pipeline script to update all graph files with the new style of graph.
>
> Then consider the following questions:
>
> 1. How do you know which graphs need to be updated?
> 2. What would you have to do if one of the books' contents changed at a later date, but you didn't know which book had changed?
> 3. Would this be a problem if it took much longer (e.g. hours) to do the book-specific analysis that is required to draw the corresponding graph?
>
> > ## Solution
> > 1. Since you made a change to the graph drawing logic, which affects *all* graphs, you can reason that *all* graphs must be updated. Assuming you made no changes to the pipeline script, running it will cause all graphs to be updated to the new style.
> > 2. You would have to issue the command to re-draw all of the graphs again, even though only one of them actually needs updating.
> > 3. Compared to our demonstration workflow which can be run in seconds, a real-life or large-scale workflow could take much longer to complete. So having to re-run the _entire_ workflow because only _one part_ of the inputs has changed could mean taking up considerable time and compute resources in order to update _all_ of the results.
> {:.solution}
{:.challenge}

[ref-zipf]: ../reference#zipfs-law

{% include links.md %}