19 lines (19 with data), 11.9 kB

ÇĽO.îdocutils.nodesöîdocumentöôö)üö}ö(î	rawsourceöîöîchildrenö]öhîsectionöôö)üö}ö(hhh]ö(hîtitleöôö)üö}ö(hîSaving and loading modelsöh]öhîTextöôöîSaving and loading modelsöůöüö}ö(hhîparentöhh
hîsourceöNîlineöNubaî
attributesö}ö(îidsö]öîclassesö]öînamesö]öîdupnamesö]öîbackrefsö]öuîtagnameöhhhh
hhî?/home/jona/work/phd/maui/maui/doc/saving-and-loading-models.rstöhKubhî	paragraphöôö)üö}ö(hîSMaui models may be saved to disk, so that they may be loaded again at a later time.öh]öhîSMaui models may be saved to disk, so that they may be loaded again at a later time.öůöüö}ö(hh/hh-h
hhNhNubah}ö(h]öh!]öh#]öh%]öh']öuh)h+hh*hKhhh
hubh
)üö}ö(hhh]ö(h)üö}ö(hîSaving a trained model to disköh]öhîSaving a trained model to disköůöüö}ö(hh@hh>h
hhNhNubah}ö(h]öh!]öh#]öh%]öh']öuh)hhh;h
hhh*hKubh,)üö}ö(hîńSaving a model to disk involves saving two files to a target directory. These files store the model weights and the maui parameters (the arguments the maui model was instantiated with). :doc:`maui` implements a the save functionöh]ö(hî║Saving a model to disk involves saving two files to a target directory. These files store the model weights and the maui parameters (the arguments the maui model was instantiated with). öůöüö}ö(hî║Saving a model to disk involves saving two files to a target directory. These files store the model weights and the maui parameters (the arguments the maui model was instantiated with). öhhLh
hhNhNubîsphinx.addnodesöîpending_xreföôö)üö}ö(hî:doc:`maui`öh]öhîinlineöôö)üö}ö(hhZh]öhîmauiöůöüö}ö(hhhh^ubah}ö(h]öh!]ö(îxreföîstdöîstd-docöeh#]öh%]öh']öuh)h\hhXubah}ö(h]öh!]öh#]öh%]öh']öîreftypeöîdocöî	refdomainöhiîrefexplicitöëî	reftargetöîmauiöîrefdocöîsaving-and-loading-modelsöîrefwarnöłuh)hVhh*hK	hhLubhî implements a the save functionöůöüö}ö(hî implements a the save functionöhhLh
hhNhNubeh}ö(h]öh!]öh#]öh%]öh']öuh)h+hh*hK	hh;h
hubhUîindexöôö)üö}ö(hhh]öh}ö(h]öh!]öh#]öh%]öh']öîentriesö]ö(îsingleöîsave() (in module maui.Maui)öîmaui.Maui.saveöhNtöauh)hłhh;h
hhîG/home/jona/work/phd/maui/maui/maui/model.py:docstring of maui.Maui.saveöhNubhUîdescöôö)üö}ö(hhh]ö(hUîdesc_signatureöôö)üö}ö(hîsave(self, destdir)öh]ö(hUîdesc_addnameöôö)üö}ö(hî
maui.Maui.öh]öhî
maui.Maui.öůöüö}ö(hhhhžh
hhNhNubah}ö(h]öh!]öh#]öh%]öh']öî	xml:spaceöîpreserveöuh)hąhhíh
hhîG/home/jona/work/phd/maui/maui/maui/model.py:docstring of maui.Maui.saveöhNubhUî	desc_nameöôö)üö}ö(hîsaveöh]öhîsaveöůöüö}ö(hhhh║h
hhNhNubah}ö(h]öh!]öh#]öh%]öh']öhÁhÂuh)hŞhhíh
hhhĚhNubhUîdesc_parameterlistöôö)üö}ö(hî
self, destdiröh]ö(hUîdesc_parameteröôö)üö}ö(hîselföh]öhîselföůöüö}ö(hhhhđubah}ö(h]öh!]öh#]öh%]öh']öhÁhÂuh)h╬hh╩ubh¤)üö}ö(hîdestdiröh]öhîdestdiröůöüö}ö(hhhhŮubah}ö(h]öh!]öh#]öh%]öh']öhÁhÂuh)h╬hh╩ubeh}ö(h]öh!]öh#]öh%]öh']öhÁhÂuh)h╚hhíh
hhhĚhNubeh}ö(h]öhŚah!]öh#]öhŚah%]öh']öîfirstöëîmoduleöî	maui.Mauiöîclassöhîfullnameöh╝uh)hčhhťh
hhhĚhNubhUîdesc_contentöôö)üö}ö(hhh]ö(h,)üö}ö(hîLSave a maui model to disk, so that it may be reloaded later using ``load()``öh]ö(hîBSave a maui model to disk, so that it may be reloaded later using öůöüö}ö(hîBSave a maui model to disk, so that it may be reloaded later using öhj
h
hhNhNubhîliteralöôö)üö}ö(hî
``load()``öh]öhîload()öůöüö}ö(hhhj

ubah}ö(h]öh!]öh#]öh%]öh']öuh)j
hj
ubeh}ö(h]öh!]öh#]öh%]öh']öuh)h+hhÖhK
hh h
hubh,)üö}ö(hî>destdir:    destination directory in which to save model filesöh]öhî>destdir:    destination directory in which to save model filesöůöüö}ö(hj#
hj!
h
hhNhNubah}ö(h]öh!]öh#]öh%]öh']öuh)h+hhÖhKhh h
hubeh}ö(h]öh!]öh#]öh%]öh']öuh)hřhhťh
hhhĚhNubeh}ö(h]öh!]öh#]öh%]öh']öîdomainöîpyöîobjtypeöîfunctionöîdesctypeöj>
înoindexöëuh)hÜh
hhh;hhÖhNubh,)üö}ö(hîôThe function takes one required parameter, the destination directory where the two files will be saved. It is called directly on a maui model, likeöh]öhîôThe function takes one required parameter, the destination directory where the two files will be saved. It is called directly on a maui model, likeöůöüö}ö(hjC
hjA
h
hhNhNubah}ö(h]öh!]öh#]öh%]öh']öuh)h+hh*hK
hh;h
hubhî
literal_blocköôö)üö}ö(hîmaui_model.save('/path/to/dir')öh]öhîmaui_model.save('/path/to/dir')öůöüö}ö(hhhjQ
ubah}ö(h]öh!]öh#]öh%]öh']öhÁhÂîlanguageöîpythonöîlinenosöëîhighlight_argsö}öuh)jO
hh*hKhh;h
hubeh}ö(h]öîsaving-a-trained-model-to-disköah!]öh#]öîsaving a trained model to disköah%]öh']öuh)h	hhh
hhh*hKubh
)üö}ö(hhh]ö(h)üö}ö(hîLoading a model from disköh]öhîLoading a model from disköůöüö}ö(hjq
hjo
h
hhNhNubah}ö(h]öh!]öh#]öh%]öh']öuh)hhjl
h
hhh*hKubh,)üö}ö(hX~
Loading a model involves instantiating a new Maui instance using the parameters that were used on the model that is saved to disk, and then populating the weights of the model to the previously trained weights. Once a model is loaded, it can be used to transform new data to the latent space, or it can be trained further. :doc:`maui` has a static function to load a model from disköh]ö(hXC
Loading a model involves instantiating a new Maui instance using the parameters that were used on the model that is saved to disk, and then populating the weights of the model to the previously trained weights. Once a model is loaded, it can be used to transform new data to the latent space, or it can be trained further. öůöüö}ö(hXC
Loading a model involves instantiating a new Maui instance using the parameters that were used on the model that is saved to disk, and then populating the weights of the model to the previously trained weights. Once a model is loaded, it can be used to transform new data to the latent space, or it can be trained further. öhj}
h
hhNhNubhW)üö}ö(hî:doc:`maui`öh]öh])üö}ö(hjł
h]öhîmauiöůöüö}ö(hhhjŐ
ubah}ö(h]öh!]ö(hhîstdöîstd-docöeh#]öh%]öh']öuh)h\hjć
ubah}ö(h]öh!]öh#]öh%]öh']öîreftypeöîdocöî	refdomainöjö
îrefexplicitöëhxîmauiöhzh{h|łuh)hVhh*hKhj}
ubhî0 has a static function to load a model from disköůöüö}ö(hî0 has a static function to load a model from disköhj}
h
hhNhNubeh}ö(h]öh!]öh#]öh%]öh']öuh)h+hh*hKhjl
h
hubhë)üö}ö(hhh]öh}ö(h]öh!]öh#]öh%]öh']öîentriesö]ö(hĽîload() (in module maui.Maui)öîmaui.Maui.loadöhNtöauh)hłhjl
h
hhîG/home/jona/work/phd/maui/maui/maui/model.py:docstring of maui.Maui.loadöhNubhŤ)üö}ö(hhh]ö(há)üö}ö(hî	load(dir)öh]ö(hŽ)üö}ö(hî
maui.Maui.öh]öhî
maui.Maui.öůöüö}ö(hhhj┼
h
hhNhNubah}ö(h]öh!]öh#]öh%]öh']öhÁhÂuh)hąhj┴
h
hhîG/home/jona/work/phd/maui/maui/maui/model.py:docstring of maui.Maui.loadöhNubh╣)üö}ö(hîloadöh]öhîloadöůöüö}ö(hhhjď
h
hhNhNubah}ö(h]öh!]öh#]öh%]öh']öhÁhÂuh)hŞhj┴
h
hhjË
hNubh╔)üö}ö(hîdiröh]öh¤)üö}ö(hîdiröh]öhîdiröůöüö}ö(hhhjŠ
ubah}ö(h]öh!]öh#]öh%]öh']öhÁhÂuh)h╬hjÔ
ubah}ö(h]öh!]öh#]öh%]öh']öhÁhÂuh)h╚hj┴
h
hhjË
hNubeh}ö(h]öj╗
ah!]öh#]öj╗
ah%]öh']öh°ëh¨î	maui.MauiöhűhhŘjÍ
uh)hčhjż
h
hhjË
hNubh■)üö}ö(hhh]ö(h,)üö}ö(hîHLoad a maui model from disk, which was previously saved using ``save()``öh]ö(hî>Load a maui model from disk, which was previously saved using öůöüö}ö(hî>Load a maui model from disk, which was previously saved using öhjh
hhNhNubj
)üö}ö(hî
``save()``öh]öhîsave()öůöüö}ö(hhhj
ubah}ö(h]öh!]öh#]öh%]öh']öuh)j
hjubeh}ö(h]öh!]öh#]öh%]öh']öuh)h+hjŻ
hK
hj
h
hubh,)üö}ö(hî7dir:    The directory from which to load the maui modelöh]öhî7dir:    The directory from which to load the maui modelöůöüö}ö(hj#hj!h
hhNhNubah}ö(h]öh!]öh#]öh%]öh']öuh)h+hjŻ
hKhj
h
hubh,)üö}ö(hî:maui_model: a maui model that was previously saved to disköh]öhî:maui_model: a maui model that was previously saved to disköůöüö}ö(hj1hj/h
hhNhNubah}ö(h]öh!]öh#]öh%]öh']öuh)h+hjŻ
hKhj
h
hubeh}ö(h]öh!]öh#]öh%]öh']öuh)hřhjż
h
hhjË
hNubeh}ö(h]öh!]öh#]öh%]öh']öj;
îpyöj=
îfunctionöj?
jJj@
ëuh)hÜh
hhjl
hjŻ
hNubh,)üö}ö(hî-It is called directly on the Maui class, likeöh]öhî-It is called directly on the Maui class, likeöůöüö}ö(hjMhjKh
hhNhNubah}ö(h]öh!]öh#]öh%]öh']öuh)h+hh*hKhjl
h
hubjP
)üö}ö(hîmaui.Maui.load('/path/to/dir')öh]öhîmaui.Maui.load('/path/to/dir')öůöüö}ö(hhhjYubah}ö(h]öh!]öh#]öh%]öh']öhÁhÂj_
îsqlöja
ëjb
}öuh)jO
hh*hKhjl
h
hubeh}ö(h]öîloading-a-model-from-disköah!]öh#]öîloading a model from disköah%]öh']öuh)h	hhh
hhh*hKubeh}ö(h]öîsaving-and-loading-modelsöah!]öh#]öîsaving and loading modelsöah%]öh']öuh)h	hhh
hhh*hKubah}ö(h]öh!]öh#]öh%]öh']öîsourceöh*uh)h
îcurrent_sourceöNîcurrent_lineöNîsettingsöîdocutils.frontendöîValuesöôö)üö}ö(hNî	generatoröNî	datestampöNîsource_linköNî
source_urlöNî
toc_backlinksöîentryöîfootnote_backlinksöK
î
sectnum_xformöK
îstrip_commentsöNîstrip_elements_with_classesöNî
strip_classesöNîreport_levelöKî
halt_levelöKîexit_status_levelöKîdebugöNîwarning_streamöNî	tracebacköłîinput_encodingöî	utf-8-sigöîinput_encoding_error_handleröîstrictöîoutput_encodingöîutf-8öîoutput_encoding_error_handleröjťîerror_encodingöîUTF-8öîerror_encoding_error_handleröîbackslashreplaceöî
language_codeöîenöîrecord_dependenciesöNîconfigöNî	id_prefixöhîauto_id_prefixöîidöî
dump_settingsöNîdump_internalsöNîdump_transformsöNîdump_pseudo_xmlöNîexpose_internalsöNîstrict_visitoröNî_disable_configöNî_sourceöh*î_destinationöNî
_config_filesö]öîpep_referencesöNîpep_base_urlöî https://www.python.org/dev/peps/öîpep_file_url_templateöîpep-%04döîrfc_referencesöNîrfc_base_urlöîhttps://tools.ietf.org/html/öî	tab_widthöKîtrim_footnote_reference_spaceöëîfile_insertion_enabledöłîraw_enabledöK
îsyntax_highlightöîlongöîsmart_quotesöłîsmartquotes_localesö]öîcharacter_level_inline_markupöëîdoctitle_xformöëî
docinfo_xformöK
îsectsubtitle_xformöëîembed_stylesheetöëîcloak_email_addressesöłîenvöNubîreporteröNîindirect_targetsö]öîsubstitution_defsö}öîsubstitution_namesö}öîrefnamesö}öîrefidsö}öînameidsö}ö(jvjsji
jf
hŚhŚjnjkj╗
j╗
uî	nametypesö}ö(jvNji
NhŚłjnNj╗
łuh}ö(jshjf
h;hŚhíjkjl
j╗
j┴
uî
footnote_refsö}öî
citation_refsö}öî
autofootnotesö]öîautofootnote_refsö]öîsymbol_footnotesö]öîsymbol_footnote_refsö]öî	footnotesö]öî	citationsö]öîautofootnote_startöK
îsymbol_footnote_startöKîid_startöK
îparse_messagesö]ö(hîsystem_messageöôö)üö}ö(hhh]ö(h,)üö}ö(hîUnexpected section title.öh]öhîUnexpected section title.öůöüö}ö(hhhj°ubah}ö(h]öh!]öh#]öh%]öh']öuh)h+hj§ubjP
)üö}ö(hîParameters
----------öh]öhîParameters
----------öůöüö}ö(hhhjubah}ö(h]öh!]öh#]öh%]öh']öhÁhÂuh)jO
hj§hhÖubeh}ö(h]öh!]öh#]öh%]öh']öîlevelöKîtypeöîSEVEREöîsourceöhÖîlineöKuh)jˇhh h
hhhÖhKubj˘)üö}ö(hhh]ö(h,)üö}ö(hîUnexpected section title.öh]öhîUnexpected section title.öůöüö}ö(hhhj"ubah}ö(h]öh!]öh#]öh%]öh']öuh)h+hjubjP
)üö}ö(hîParameters
----------öh]öhîParameters
----------öůöüö}ö(hhhj0ubah}ö(h]öh!]öh#]öh%]öh']öhÁhÂuh)jO
hjhjŻ
ubeh}ö(h]öh!]öh#]öh%]öh']öîlevelöKîtypeöjîsourceöjŻ
îlineöKuh)jˇhj
h
hhjŻ
hKubj˘)üö}ö(hhh]ö(h,)üö}ö(hîUnexpected section title.öh]öhîUnexpected section title.öůöüö}ö(hhhjKubah}ö(h]öh!]öh#]öh%]öh']öuh)h+hjHubjP
)üö}ö(hîReturns
-------öh]öhîReturns
-------öůöüö}ö(hhhjYubah}ö(h]öh!]öh#]öh%]öh']öhÁhÂuh)jO
hjHhjŻ
ubeh}ö(h]öh!]öh#]öh%]öh']öîlevelöKîtypeöjîsourceöjŻ
îlineöK	uh)jˇhj
h
hhjŻ
hK	ubeîtransform_messagesö]öîtransformeröNî
decorationöNh
hub.