📜 API Documentation#
tl;dr
The API documentation is comprehensive and can be overwhelming. The most important parts are:
pipefunc.pipefunc: the@pipefuncdecoratorpipefunc.PipeFunc: the class that is returned by the@pipefuncdecoratorpipefunc.Pipeline: the class containing thePipeFuncinstancespipefunc.Pipeline.run: run functions inline sequentiallypipefunc.Pipeline.map: run functions that may contain map-reduce operations in parallel
pipefuncmoduleErrorSnapshotErrorSnapshot.functionErrorSnapshot.exceptionErrorSnapshot.argsErrorSnapshot.kwargsErrorSnapshot.tracebackErrorSnapshot.timestampErrorSnapshot.userErrorSnapshot.machineErrorSnapshot.ip_addressErrorSnapshot.current_directoryErrorSnapshot.reproduce()ErrorSnapshot.save_to_file()ErrorSnapshot.load_from_file()
NestedPipeFuncPipeFuncPipeFunc.error_snapshotPipeFunc.renamesPipeFunc.boundPipeFunc.output_namePipeFunc.parametersPipeFunc.original_parametersPipeFunc.defaultsPipeFunc.output_pickerPipeFunc.update_defaults()PipeFunc.update_renames()PipeFunc.update_scope()PipeFunc.update_mapspec_axes()PipeFunc.update_bound()PipeFunc.copy()PipeFunc.profilePipeFunc.parameter_scopesPipeFunc.unscoped_parametersPipeFunc.parameter_annotationsPipeFunc.output_annotationPipeFunc.requires_mapping
PipelinePipeline.info()Pipeline.profilePipeline.debugPipeline.print_errorPipeline.add()Pipeline.drop()Pipeline.replace()Pipeline.output_to_funcPipeline.node_mappingPipeline.graphPipeline.func()Pipeline.run()Pipeline.map()Pipeline.map_async()Pipeline.arg_combinations()Pipeline.root_args()Pipeline.func_dependencies()Pipeline.func_dependents()Pipeline.defaultsPipeline.scopesPipeline.update_defaults()Pipeline.update_renames()Pipeline.update_mapspec_axes()Pipeline.update_scope()Pipeline.parameter_annotationsPipeline.output_annotationsPipeline.all_arg_combinationsPipeline.all_root_argsPipeline.mapspec_namesPipeline.mapspecs()Pipeline.mapspecs_as_stringsPipeline.mapspec_dimensionsPipeline.mapspec_axesPipeline.validate()Pipeline.unique_leaf_nodePipeline.topological_generationsPipeline.sorted_functionsPipeline.all_output_namesPipeline.add_mapspec_axis()Pipeline.visualize()Pipeline.visualize_graphviz()Pipeline.visualize_graphviz_widget()Pipeline.visualize_matplotlib()Pipeline.visualize_holoviews()Pipeline.print_profiling_stats()Pipeline.simplified_pipeline()Pipeline.leaf_nodesPipeline.root_nodesPipeline.profiling_statsPipeline.copy()Pipeline.error_snapshotPipeline.nest_funcs()Pipeline.join()Pipeline.split_disconnected()Pipeline.independent_axes_in_mapspecs()Pipeline.subpipeline()Pipeline.print_documentation()Pipeline.pydantic_model()Pipeline.cli()
VariantPipelinepipefunc()
pipefunc.mapmoduleDictArrayFileArrayMapSpecRunInfoRunInfo.inputsRunInfo.defaultsRunInfo.all_output_namesRunInfo.shapesRunInfo.resolved_shapesRunInfo.internal_shapesRunInfo.shape_masksRunInfo.run_folderRunInfo.mapspecs_as_stringsRunInfo.storageRunInfo.error_handlingRunInfo.pipefunc_versionRunInfo.create()RunInfo.storage_class()RunInfo.init_store()RunInfo.input_pathsRunInfo.defaults_pathRunInfo.mapspecsRunInfo.dump()RunInfo.load()RunInfo.path()RunInfo.resolve_downstream_shapes()
SharedMemoryDictArrayStorageBaseStorageBase.folderStorageBase.shapeStorageBase.internal_shapeStorageBase.shape_maskStorageBase.storage_idStorageBase.requires_serializationStorageBase.resolved_shapeStorageBase.resolved_internal_shapeStorageBase.full_shape_is_resolved()StorageBase.get_from_index()StorageBase.has_index()StorageBase.to_array()StorageBase.maskStorageBase.mask_linear()StorageBase.dump()StorageBase.dump_in_subprocessStorageBase.sizeStorageBase.rankStorageBase.full_shapeStorageBase.stridesStorageBase.persist()
load_all_outputs()load_dataframe()load_outputs()load_xarray_dataset()register_storage()run_map()run_map_async()ZarrFileArrayZarrMemoryArrayZarrSharedMemoryArray
pipefunc.map.adaptivemodulepipefunc.map.xarraymodulepipefunc.map.adaptive_schedulermoduleAdaptiveSchedulerDetailsAdaptiveSchedulerDetails.learnersAdaptiveSchedulerDetails.fnamesAdaptiveSchedulerDetails.dependenciesAdaptiveSchedulerDetails.nodesAdaptiveSchedulerDetails.cores_per_nodeAdaptiveSchedulerDetails.extra_schedulerAdaptiveSchedulerDetails.partitionAdaptiveSchedulerDetails.executor_typeAdaptiveSchedulerDetails.kwargs()AdaptiveSchedulerDetails.run_manager()
slurm_run_setup()
pipefunc.cachemodulepipefunc.helpersmodulepipefunc.resourcesmoduleResourcesResources.cpusResources.cpus_per_nodeResources.nodesResources.memoryResources.gpusResources.timeResources.partitionResources.extra_argsResources.parallelization_modeResources.from_dict()Resources.maybe_from_dict()Resources.to_slurm_options()Resources.update()Resources.combine_max()Resources.with_defaults()Resources.maybe_with_defaults()Resources.dict()
pipefunc.lazymodulepipefunc.mcpmodulepipefunc.sweepmodulepipefunc.testingmodulepipefunc.typingmodule