some issues with two examples from the tutorials directory #624
Conversation
There was a problem hiding this comment.
Cool, thanks for the fixes!
Just a couple of nit-picks:
- as a general comment, we try to use a common prefix for patches which it's a sort of tag representing the main subsystem interested. Thus, for these patches, something like
ipynb: tutorial:should do the job (git lg on the file is usually a good reference). - for the last patch, let's avoid commit header ending with "...", just use one single line for the commit title and (when useful) add one/more sentence in the commit message body
| "\n", | ||
| "# Load the platform information\n", | ||
| "with open('../../results/SchedTuneAnalysis/platform.json', 'r') as fh:\n", | ||
| "with open(res_dir + os.sep + 'platform.json', 'r') as fh:\n", |
There was a problem hiding this comment.
Instead of hardcoded concatenations, we preferably use:
os.path.join(res_dir, 'platform.json')
|
i hope i addressed the concerns - ? |
|
it's been two months and nobody seems to be using the tutorial. in that case it's probably better if the tutorials were deleted? |
|
Hi @v0lker, Sorry about that. Notebooks are quite a pain to maintain because you can't really add a Travis job to make sure they still work (you can translate them to a Python script, but then you have nothing to check that e.g. the plots got rendered correctly). Some of those Notebooks serve a dual purpose - both API documentation and tutorial/example code. This stems from the fact that currently our API documentation is in a poor shape, and that sometimes writing pure code is simpler than writing text... A non negligible work that remains to be done on https://github.com/ARM-software/lisa/tree/next is to do a summer cleaning of those notebooks - remove redundant ones, remove those serving as pure API documentation, and only keep a few useful example ones. The rest should live in the documentation, and that can actually be CI-tested via https://docs.python.org/3.5/library/doctest.html. |
tutorial/00_LisaInANutshell: should be trying to set ENERGY_AWARE scheduling as root, otherwise permission will be denied (i haven't tested the rest of the file)
tutorial/UseCaseExamples_SchedTuneAnalysis: was not using the path that was set to load the trace file and the ASCII trace file is missing, therefore need to generate it
there are more issues, at least with the latter one.