IЦi&SSKrSSKrSSKJr SSKJrJrJrJr SSK J r J r J r SSK JrJrJrJr SSKJr /SQr\"SS 9"S S 55r"S S \R,5r"SS\R,5rg)N) dataclass)AnyListOptionalUnion)Metadata MetadataIndex StorageMeta)LoadPlan LoadPlannerSavePlan SavePlanner)Future) WriteResult StorageWriter StorageReaderT)frozenc4\rSrSr%\\S'\\S'\\S'Srg)rindex size_in_bytes storage_dataN) __name__ __module__ __qualname____firstlineno__r __annotations__intr__static_attributes__rc/var/www/html/ai-image-ml/venv/lib/python3.13/site-packages/torch/distributed/checkpoint/storage.pyrrs r!rc \rSrSrSr\R SS\\\ RS4SS4Sjj5r \R S\ SS4Sj5r \R S \S\4S j5r\R S \\S\\4S j5r\R S \S \S\\\4Sj5r\R S\S\\\SS4Sj5r\\R S\\\ R4S\ 4Sj55rS\\4SjrSrg)ra Interface used by ``save_state_dict`` to write to storage. One StorageWriter instance acts as both the coordinator and the follower in a distributed checkpoint. As part of initialization, each instance is told its role. A subclass should expect the following sequence of calls. 0) (all ranks) set checkpoint_id if users pass a valid checkpoint_id. 1) (all ranks) set_up_storage_writer() 2) (all ranks) prepare_local_plan() 3) (coordinator) prepare_global_plan() 4) (all ranks) write_data() 5) (coordinator) finish() N checkpoint_idreturncg)aI Calls to indicates a brand new checkpoint write is going to happen. A checkpoint_id may be present if users set the checkpoint_id for this checkpoint write. The meaning of the checkpiont_id is storage-dependent. It can be a path to a folder/file or a key for a key-value storage. Args: checkpoint_id (Union[str, os.PathLike, None]): The ID of this checkpoint instance. The meaning of the checkpoint_id depends on the storage. It can be a path to a folder or to a file. It can also be a key if the storage is a key-value store. (Default: ``None``) Nrselfr%s r"resetStorageWriter.reset- r!is_coordinatorcg)z Initialize this instance. Args: is_coordinator (bool): Whether this instance is responsible for coordinating the checkpoint. Nr)r)r-s r"set_up_storage_writer#StorageWriter.set_up_storage_writer?r!plancg)aI Perform storage-specific local planning. While this method can produce a completely different plan, the recommended way is to store storage specific data in SavePlan::storage_data. Args: plan (SavePlan): The local plan from the ``SavePlanner`` in use. Returns: A transformed ``SavePlan`` after storage local planning Nrr)r2s r"prepare_local_plan StorageWriter.prepare_local_planIr1r!planscg)a Perform centralized planning of storage. This method is only called on the coordinator instance. While this method can produce a completely different plan, the preferred way is to store storage specific data in SavePlan::storage_data. Args: plans: A list of ``SavePlan`` instances, one for each rank. Returns: A list of transformed ``SavePlan`` after storage global planning Nrr)r7s r"prepare_global_plan!StorageWriter.prepare_global_planXr1r!plannercg)a Write all items from ``plan`` using ``planner`` to resolve the data. A subclass should call ``SavePlanner::resolve_data`` on each item from the plan to get access to the underlying object to write. Subclasses should lazily call `resolve_data` as it can allocate memory. In case of tensors, make following assumptions: - They might be on any device, including not matching the one on ``WriteItem::tensor_data`` - They might be views or not contiguous. Only the projection needs to be saved. Args: plan (SavePlan): The save plan to execute. planner (SavePlanner): Planner object to be used to resolve items to data. Returns: A future that completes to a list of WriteResult Nrr)r2r<s r" write_dataStorageWriter.write_datair1r!metadataresultscg)am Write the metadata and marks the current checkpoint as successful. The actual format/schema used for serializing `metadata` is an implementation detail. The only requirement is that it's recoverable in to the same object graph. Args: metadata (Metadata): metadata for the new checkpoint results: A list of WriteResults from all ranks. Returns: None Nr)r)rArBs r"finishStorageWriter.finishr1r!cgzt Check if the given checkpoint_id is supported by the stroage. This allow us to enable automatic storage selection. Nrclsr%s r"validate_checkpoint_id$StorageWriter.validate_checkpoint_id r!cg)a Return the storage-specific metadata. This is used to store additional information in a checkpoint that can be useful for providing request-level observability. StorageMeta is passed to the ``SavePlanner`` during save calls. Returns None by default. TODO: provide an example Nrr)s r" storage_metaStorageWriter.storage_metasr!rN)rrrr__doc__abcabstractmethodrstrosPathLiker*boolr/r r5rr:rrrr?rrD classmethodrJrr rOr rr!r"rrs"  5bkk4)?#@ D  "  D T     x  H      h DN     '2 [! "  .  x $tK7H2I d   5bkk9I3J t  h{3r!rc\rSrSrSr\R SS\\\ RS4SS4Sjj5r \R S\ 4Sj5r \R S\ S \SS4S j5r\R S \S\4S j5r\R S \\S\\4Sj5r\R S \S\S\S4Sj5r\\R S\\\ R4S\4Sj55rSrg)ra& Interface used by ``load_state_dict`` to read from storage. One StorageReader instance acts as both the coordinator and the follower in a distributed checkpoint. As part of initialization, each instance is told its role. A subclass should expected the following sequence of calls by ``load_state_dict``: 0) (all ranks) set checkpoint_id if users pass a valid checkpoint_id. 1) (all ranks) read_metadata() 2) (all ranks) set_up_storage_reader() 3) (all ranks) prepare_local_plan() 4) (coordinator) prepare_global_plan() 5) (all ranks) read_data() Nr%r&cg)aQ Calls to indicates a brand new checkpoint read is going to happen. A checkpoint_id may be present if users set the checkpoint_id for this checkpoint read. The meaning of the checkpiont_id is storage-dependent. It can be a path to a folder/file or a key for a key-value storage. Args: checkpoint_id (Union[str, os.PathLike, None]): The ID of this checkpoint instance. The meaning of the checkpoint_id depends on the storage. It can be a path to a folder or to a file. It can also be a key if the storage is more like a key-value store. (Default: ``None``) Nrr(s r"r*StorageReader.resetr,r!cg)zo Read the checkpoint metadata. Returns: The metadata object associated with the checkpoint being loaded. NrrNs r" read_metadataStorageReader.read_metadatar1r!rAr-cg)z Initialize this instance. Args: metadata (Metadata): The metadata schema to use. is_coordinator (bool): Whether this instance is responsible for coordinating the checkpoint. Nr)r)rAr-s r"set_up_storage_reader#StorageReader.set_up_storage_readerr1r!r2cg)aF Perform storage-specific local planning. While this method can produce a completely different plan, the recommended way is to store storage specific data in LoadPlan::storage_data. Args: plan (LoadPlan): The local plan from the ``LoadPlan`` in use. Returns: A transformed ``LoadPlan`` after storage local planning Nrr4s r"r5 StorageReader.prepare_local_planr1r!r7cg)a Perform centralized planning of storage loading. This method is only called on the coordinator instance. While this method can produce a completely different plan, the preferred way is to store storage specific data in LoadPlan::storage_data. Args: plans: A list of ``LoadPlan`` instances, one for each rank. Returns: A list of transformed ``LoadPlan`` after storage global planning Nrr9s r"r:!StorageReader.prepare_global_planr1r!r<cg)aC Read all items from ``plan`` using ``planner`` to resolve the data. A subclass should call ``LoadPlanner::load_bytes`` to deserialize a BytesIO object into the right place. A subclass should call ``LoadPlanner::resolve_tensor`` to get access to the tensors that in should load data into. It's the StorageLayer responsibility to properly schedule any cross device copies required. Args: plan (LoadPlan): The local plan to execute on planner (LoadPlanner): The planner object to use to resolve items. Returns: A future that completes once all reads are finished. Nrr>s r" read_dataStorageReader.read_datar1r!cgrGrrHs r"rJ$StorageReader.validate_checkpoint_idrLr!rrQ)rrrrrRrSrTrrUrVrWr*rr_rXrbr r5rr:r rrirYrJr rr!r"rrsY"  5bkk4)?#@ D  "  x    h  QU     x  H      h DN    h    * 5bkk9I3J t  r!r)rSrV dataclassesrtypingrrrr%torch.distributed.checkpoint.metadatarr r $torch.distributed.checkpoint.plannerr r r r torch.futuresr__all__rABCrrrr!r"rtss !--VV ! < $HCGGHVv CGGv r!