nvflare.fuel.utils package

Subpackages

• nvflare.fuel.utils.fobs package
  • Subpackages
    • nvflare.fuel.utils.fobs.decomposers package
      • Submodules
      • Module contents
  • Submodules
    • nvflare.fuel.utils.fobs.buf_list_stream module
      • BufListStream
    • nvflare.fuel.utils.fobs.builtin_decomposers module
    • nvflare.fuel.utils.fobs.datum module
      • Datum
      • DatumManager
      • DatumRef
      • DatumType
    • nvflare.fuel.utils.fobs.decomposer module
      • DataClassDecomposer
      • Decomposer
      • DictDecomposer
      • EnumTypeDecomposer
      • Externalizer
      • Internalizer
      • new_empty_container()
    • 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
    • FOBSContextKey
      • FOBSContextKey.ABORT_SIGNAL
      • FOBSContextKey.CELL
      • FOBSContextKey.CORE_CELL
      • FOBSContextKey.DOWNLOAD_COMPLETE_CB
      • FOBSContextKey.DOWNLOAD_REQ_TIMEOUT
      • FOBSContextKey.MESSAGE
      • FOBSContextKey.NUM_RECEIVERS
      • FOBSContextKey.PASS_THROUGH
      • FOBSContextKey.SEC_CREDS
• nvflare.fuel.utils.pipe package
  • Submodules
    • nvflare.fuel.utils.pipe.cell_pipe module
      • CellPipe
    • nvflare.fuel.utils.pipe.file_accessor module
      • FileAccessor
    • nvflare.fuel.utils.pipe.file_name_utils module
      • file_name_to_message()
      • message_to_file_name()
    • nvflare.fuel.utils.pipe.file_pipe module
      • FilePipe
    • nvflare.fuel.utils.pipe.fobs_file_accessor module
      • FobsFileAccessor
    • nvflare.fuel.utils.pipe.memory_pipe module
      • MemoryPipe
    • nvflare.fuel.utils.pipe.pipe module
      • Message
      • Pipe
      • Topic
    • nvflare.fuel.utils.pipe.pipe_handler module
      • PipeHandler
  • Module contents

Submodules

• nvflare.fuel.utils.admin_name_utils module
  • is_valid_admin_client_name()
  • new_admin_client_name()
• nvflare.fuel.utils.app_config_utils module
  • get_int_var()
  • get_positive_float_var()
  • get_positive_int_var()
• nvflare.fuel.utils.argument_utils module
  • SafeArgumentParser
    • SafeArgumentParser.error()
  • parse_var()
  • parse_vars()
  • str2bool()
• nvflare.fuel.utils.attributes_exportable module
  • AttributesExportable
    • AttributesExportable.export()
  • ExportMode
    • ExportMode.PEER
    • ExportMode.SELF
  • export_components()
• nvflare.fuel.utils.buffer_list module
  • BufferList
    • BufferList.append()
    • BufferList.flatten()
    • BufferList.get_list()
    • BufferList.get_size()
    • BufferList.read()
• nvflare.fuel.utils.class_loader module
  • get_class_name()
  • load_class()
• nvflare.fuel.utils.class_utils module
  • ModuleScanner
    • ModuleScanner.create_classes_table()
    • ModuleScanner.get_module_name()
  • get_class_path_from_config()
  • get_component_init_parameters()
  • instantiate_class()
• nvflare.fuel.utils.component_builder module
  • ComponentBuilder
    • ComponentBuilder.build_component()
    • ComponentBuilder.build_nested_component()
    • ComponentBuilder.get_class_path()
    • ComponentBuilder.get_module_scanner()
    • ComponentBuilder.is_authorizable_component_config()
    • ComponentBuilder.is_class_config()
  • ConfigType
    • ConfigType.COMPONENT
    • ConfigType.DICT
• nvflare.fuel.utils.components_utils module
  • create_classes_table_static()
• nvflare.fuel.utils.config module
  • Config
    • Config.get_exts()
    • Config.get_format()
    • Config.get_location()
    • Config.get_native_conf()
    • Config.to_dict()
    • Config.to_str()
  • ConfigFormat
    • ConfigFormat.JSON
    • ConfigFormat.OMEGACONF
    • ConfigFormat.PYHOCON
    • ConfigFormat.config_ext_formats()
    • ConfigFormat.extensions()
  • ConfigLoader
    • ConfigLoader.get_format()
    • ConfigLoader.load_config()
    • ConfigLoader.load_config_from_dict()
    • ConfigLoader.load_config_from_str()
• nvflare.fuel.utils.config_factory module
  • ConfigFactory
    • ConfigFactory.OmegaConfLoader
      • ConfigFactory.OmegaConfLoader.load_config()
      • ConfigFactory.OmegaConfLoader.load_config_from_dict()
      • ConfigFactory.OmegaConfLoader.load_config_from_str()
    • ConfigFactory.PyhoconLoader
      • ConfigFactory.PyhoconLoader.load_config()
      • ConfigFactory.PyhoconLoader.load_config_from_dict()
      • ConfigFactory.PyhoconLoader.load_config_from_str()
    • ConfigFactory.get_config_loader()
    • ConfigFactory.get_file_basename()
    • ConfigFactory.has_config()
    • ConfigFactory.load_config()
    • ConfigFactory.logger
    • ConfigFactory.match_config()
    • ConfigFactory.omega_import_ok
    • ConfigFactory.pyhocon_import_ok
    • ConfigFactory.search_config_format()
• nvflare.fuel.utils.config_service module
  • ConfigService
    • ConfigService.add_section()
    • ConfigService.config_not_found_msg()
    • ConfigService.find_file()
    • ConfigService.get_bool_var()
    • ConfigService.get_dict_var()
    • ConfigService.get_float_var()
    • ConfigService.get_int_var()
    • ConfigService.get_section()
    • ConfigService.get_str_var()
    • ConfigService.get_var_values()
    • ConfigService.initialize()
    • ConfigService.load_config_dict()
    • ConfigService.load_configuration()
    • ConfigService.logger
    • ConfigService.reset()
  • find_file_in_dir()
  • search_file()
• nvflare.fuel.utils.constants module
  • FrameworkType
    • FrameworkType.NUMPY
    • FrameworkType.PYTORCH
    • FrameworkType.RAW
    • FrameworkType.TENSORFLOW
  • Mode
    • Mode.ACTIVE
    • Mode.PASSIVE
  • PipeChannelName
    • PipeChannelName.METRIC
    • PipeChannelName.TASK
• nvflare.fuel.utils.deprecated module
  • deprecated()
• nvflare.fuel.utils.dict_utils module
  • augment()
  • extract_first_level_primitive()
  • merge_dict()
  • update()
  • update_components()
  • update_configs_with_envs()
• nvflare.fuel.utils.experimental module
  • experimental()
• nvflare.fuel.utils.fsm module
  • FSM
    • FSM.STATE_NAME_EXIT
    • FSM.add_state()
    • FSM.execute()
    • FSM.get_current_state()
    • FSM.get_prop()
    • FSM.set_current_state()
    • FSM.set_prop()
  • State
    • State.enter()
    • State.execute()
    • State.leave()
• nvflare.fuel.utils.function_utils module
  • find_task_fn()
  • require_arguments()
• nvflare.fuel.utils.gpu_utils module
  • get_host_gpu_ids()
  • get_host_gpu_memory_free()
  • get_host_gpu_memory_total()
  • has_nvidia_smi()
  • use_nvidia_smi()
• nvflare.fuel.utils.grpc_utils module
  • create_channel()
• nvflare.fuel.utils.hash_utils module
  • UniformHash
    • UniformHash.get_num_buckets()
    • UniformHash.hash()
• nvflare.fuel.utils.import_utils module
  • LazyImportError
  • check_version()
  • get_module_version()
  • get_module_version_str()
  • optional_import()
• nvflare.fuel.utils.job_utils module
  • build_client_hierarchy()
• nvflare.fuel.utils.json_config_loader module
  • JsonConfig
    • JsonConfig.to_dict()
    • JsonConfig.to_str()
  • JsonConfigLoader
    • JsonConfigLoader.load_config()
    • JsonConfigLoader.load_config_from_dict()
    • JsonConfigLoader.load_config_from_str()
• nvflare.fuel.utils.json_scanner module
  • JsonObjectProcessor
    • JsonObjectProcessor.process_element()
  • JsonScanner
    • JsonScanner.get_post_proces_err_msg()
    • JsonScanner.get_process_err_msg()
    • JsonScanner.scan()
  • Node
    • Node.parent_element()
    • Node.path()
• nvflare.fuel.utils.log_utils module
  • ANSIColor
    • ANSIColor.COLORS
    • ANSIColor.DEFAULT_LEVEL_COLORS
    • ANSIColor.colorize()
  • BaseFormatter
    • BaseFormatter.format()
    • BaseFormatter.remove_empty_attributes()
  • ColorFormatter
    • ColorFormatter.format()
  • JsonFormatter
    • JsonFormatter.format()
    • JsonFormatter.formatMessageDict()
    • JsonFormatter.generate_fmt_dict()
  • LogMode
    • LogMode.CONCISE
    • LogMode.FULL
    • LogMode.MSG_ONLY
    • LogMode.RELOAD
    • LogMode.VERBOSE
  • LoggerNameFilter
    • LoggerNameFilter.filter()
    • LoggerNameFilter.matches_name()
  • add_log_file_handler()
  • apply_log_config()
  • center_message()
  • configure_logging()
  • custom_logger()
  • dynamic_log_config()
  • get_module_logger()
  • get_obj_logger()
  • get_script_logger()
  • print_logger_hierarchy()
  • validate_site_log_config()
• nvflare.fuel.utils.mem_utils module
  • log_rss()
• nvflare.fuel.utils.memory_utils module
  • cleanup_memory()
  • get_allocator_type()
  • try_malloc_trim()
• nvflare.fuel.utils.msg_root_utils module
  • delete_msg_root()
  • subscribe_to_msg_root()
• nvflare.fuel.utils.network_utils module
  • get_local_addresses()
  • get_open_ports()
• nvflare.fuel.utils.obj_utils module
  • get_size()
• nvflare.fuel.utils.str_utils module
  • replace_chars()
• nvflare.fuel.utils.time_utils module
  • time_to_string()
• nvflare.fuel.utils.tree_utils module
  • Forest
  • Node
  • build_forest()
  • build_path()
  • forest_to_dict()
• nvflare.fuel.utils.url_utils module
  • make_url()
• nvflare.fuel.utils.validation_utils module
  • DefaultValuePolicy
    • DefaultValuePolicy.ALL
    • DefaultValuePolicy.ANY
    • DefaultValuePolicy.DISALLOW
    • DefaultValuePolicy.EMPTY
    • DefaultValuePolicy.RANDOM
    • DefaultValuePolicy.valid_policy()
  • check_callable()
  • check_non_empty_str()
  • check_non_negative_int()
  • check_non_negative_number()
  • check_number_range()
  • check_object_type()
  • check_positive_int()
  • check_positive_number()
  • check_str()
  • normalize_config_arg()
  • validate_candidate()
  • validate_candidates()
• nvflare.fuel.utils.waiter_utils module
  • WaiterRC
    • WaiterRC.ABORTED
    • WaiterRC.ERROR
    • WaiterRC.IS_SET
    • WaiterRC.OK
    • WaiterRC.TIMEOUT
  • conditional_wait()
• nvflare.fuel.utils.wfconf module
  • ConfigContext
  • Configurator
    • Configurator.build_component()
    • Configurator.configure()
    • Configurator.finalize_config()
    • Configurator.get_class_path()
    • Configurator.is_configured_subclass()
    • Configurator.process_args()
    • Configurator.process_config_element()
    • Configurator.process_element()
    • Configurator.start_config()
  • get_component_refs()
  • resolve_var_refs()
• nvflare.fuel.utils.zip_utils module
  • get_all_file_paths()
  • ls_zip_from_bytes()
  • normpath_for_zip()
  • remove_leading_dotdot()
  • split_path()
  • unzip_all_from_bytes()
  • unzip_all_from_file()
  • unzip_single_file_from_bytes()
  • zip_directory_to_bytes()
  • zip_directory_to_file()

Module contents