rses-dl-course / rses-dl-course.github.io

Other
8 stars 4 forks source link

Forcing a failure in ToDo cells #16

Closed EdwinB12 closed 1 year ago

EdwinB12 commented 1 year ago

@MaxGamill-Sheffield raised that the majority of one-one issues he solved were from people not running the cells that required action from the user.

e.g:

model = tf.keras.Sequential([
    #TODO - Add model layers as described above
])

as this doesn't fail at this cell but throws errors later on in the notebook, participants potentially don't realise that they've missed a cell and struggle to debug themselves.

After chatting with @twinkarma and @MaxGamill-Sheffield, a potential solution that filling the code with something that throws errors if unchanged would direct the user to the correct cell if they've pressed run all.

EdwinB12 commented 1 year ago

Something like this?

raise Exception('This cell has a TODO task! Please complete the TODO task and remove the raise Exception statement.')

model = tf.keras.Sequential([
    #TODO - Add model layers as described above
])

There may be a more elegant solution. A global command that throws an exception if it finds a #TODO would be cool. .