--- a +++ b/docs-source/source/simclr.rst @@ -0,0 +1,16 @@ +.. currentmodule:: slideflow.simclr + +slideflow.simclr +================ + +This module contains utility functions for training a SimCLR model. Please see +:ref:`simclr_ssl` for more information on the high-level API and recommended use. + +.. autofunction:: slideflow.simclr.get_args +.. autofunction:: slideflow.simclr.load +.. autofunction:: slideflow.simclr.load_model_args +.. autofunction:: slideflow.simclr.run_simclr + +.. autoclass:: slideflow.simclr.SimCLR +.. autoclass:: slideflow.simclr.SimCLR_Args +.. autoclass:: slideflow.simclr.DatasetBuilder