nvflare.fuel.utils.fobs package

Subpackages

• nvflare.fuel.utils.fobs.decomposers package
  • Submodules
    • nvflare.fuel.utils.fobs.decomposers.core_decomposers module
      • DatetimeDecomposer
      • OrderedDictDecomposer
      • SetDecomposer
      • TupleDecomposer
    • nvflare.fuel.utils.fobs.decomposers.via_downloader module
      • EncKey
      • EncType
      • LazyDownloadRef
      • LazyDownloadRefDecomposer
      • ViaDownloaderDecomposer
      • clear_download_initiated()
      • was_download_initiated()
  • Module contents

Submodules

• nvflare.fuel.utils.fobs.buf_list_stream module
  • BufListStream
    • BufListStream.getvalue()
    • BufListStream.read()
    • BufListStream.write()
• nvflare.fuel.utils.fobs.builtin_decomposers module
• nvflare.fuel.utils.fobs.datum module
  • Datum
    • Datum.blob_datum()
    • Datum.file_datum()
    • Datum.set_restore_func()
    • Datum.text_datum()
  • DatumManager
    • DatumManager.add_datum()
    • DatumManager.externalize()
    • DatumManager.get_datum()
    • DatumManager.get_datums()
    • DatumManager.get_error()
    • DatumManager.get_fobs_context()
    • DatumManager.get_original()
    • DatumManager.internalize()
    • DatumManager.post_process()
    • DatumManager.register_copy()
    • DatumManager.register_post_cb()
    • DatumManager.set_error()
  • DatumRef
  • DatumType
    • DatumType.BLOB
    • DatumType.FILE
    • DatumType.TEXT
• nvflare.fuel.utils.fobs.decomposer module
  • DataClassDecomposer
    • DataClassDecomposer.decompose()
    • DataClassDecomposer.recompose()
    • DataClassDecomposer.supported_type()
  • Decomposer
    • Decomposer.decompose()
    • Decomposer.process_datum()
    • Decomposer.recompose()
    • Decomposer.supported_dots()
    • Decomposer.supported_type()
  • DictDecomposer
    • DictDecomposer.decompose()
    • DictDecomposer.recompose()
    • DictDecomposer.supported_type()
  • EnumTypeDecomposer
    • EnumTypeDecomposer.decompose()
    • EnumTypeDecomposer.recompose()
    • EnumTypeDecomposer.supported_type()
  • Externalizer
    • Externalizer.externalize()
  • Internalizer
    • Internalizer.internalize()
  • restore_position()
• nvflare.fuel.utils.fobs.dots module
• nvflare.fuel.utils.fobs.fobs module
  • add_type_name_whitelist()
  • auto_register_enum_types()
  • deserialize()
  • deserialize_stream()
  • get_dot_handler()
  • num_decomposers()
  • register()
  • register_data_classes()
  • register_enum_types()
  • register_folder()
  • reset()
  • serialize()
  • serialize_stream()
• nvflare.fuel.utils.fobs.lobs module
  • dump_to_bytes()
  • dump_to_file()
  • dump_to_stream()
  • get_datum_dir()
  • load_from_bytes()
  • load_from_file()
  • load_from_stream()

Module contents

class FOBSContextKey

Bases: object

ABORT_SIGNAL = 'abort_signal'

CELL = 'cell'

CORE_CELL = 'core_cell'

DOWNLOAD_COMPLETE_CB = 'download_complete_cb'

DOWNLOAD_REQ_TIMEOUT = 'download_req_timeout'

MESSAGE = 'message'

NUM_RECEIVERS = 'num_receivers'

PASS_THROUGH = 'pass_through'

SEC_CREDS = 'sec_creds'