search

PPPLDeepLearning / plasma-python

PPPL deep learning disruption prediction package
http://tigress-web.princeton.edu/~alexeys/docs-web/html/
79 stars 43 forks source link

Docstrings 1 #6

Closed ASvyatkovskiy closed 7 years ago

ASvyatkovskiy commented 7 years ago

The purpose of this PR is to add meaningful and exhaustive docstrings to the code. This is the first PR out of multiple (which will follow). Docstrings added to: plasma.models.build_callbacks MPIModel.train_epoch MPIModel.get_deltas, mpi_average_scalars, mpi_sum_scalars

The PR also contains a minor change to the code: add exception type to the try-except construct as originally introduced here: https://github.com/PPPLDeepLearning/plasma-python/pull/4