API Reference

• ffcv.writer module
  • from_shard()
  • count_samples_in_shard()
  • handle_sample()
  • worker_job_webdataset()
  • worker_job_indexed_dataset()
  • DatasetWriter
    • DatasetWriter.prepare()
    • DatasetWriter.from_indexed_dataset()
    • DatasetWriter.from_webdataset()
    • DatasetWriter.finalize()
• ffcv.transforms module
  • ToTensor
    • ToTensor.generate_code()
    • ToTensor.declare_state_and_memory()
  • ToDevice
    • ToDevice.generate_code()
    • ToDevice.declare_state_and_memory()
  • ToTorchImage
    • ToTorchImage.generate_code()
    • ToTorchImage.declare_state_and_memory()
  • NormalizeImage
    • NormalizeImage.generate_code()
    • NormalizeImage.generate_code_gpu()
    • NormalizeImage.generate_code_cpu()
    • NormalizeImage.declare_state_and_memory()
  • Convert
    • Convert.generate_code()
    • Convert.declare_state_and_memory()
  • Squeeze
    • Squeeze.generate_code()
    • Squeeze.declare_state_and_memory()
  • View
    • View.generate_code()
    • View.declare_state_and_memory()
  • RandomResizedCrop
    • RandomResizedCrop.generate_code()
    • RandomResizedCrop.declare_state_and_memory()
  • RandomHorizontalFlip
    • RandomHorizontalFlip.generate_code()
    • RandomHorizontalFlip.declare_state_and_memory()
  • RandomTranslate
    • RandomTranslate.generate_code()
    • RandomTranslate.declare_state_and_memory()
  • Cutout
    • Cutout.generate_code()
    • Cutout.declare_state_and_memory()
  • ImageMixup
    • ImageMixup.generate_code()
    • ImageMixup.declare_state_and_memory()
  • LabelMixup
    • LabelMixup.generate_code()
    • LabelMixup.declare_state_and_memory()
  • MixupToOneHot
    • MixupToOneHot.generate_code()
    • MixupToOneHot.declare_state_and_memory()
  • Poison
    • Poison.generate_code()
    • Poison.declare_state_and_memory()
  • ReplaceLabel
    • ReplaceLabel.generate_code()
    • ReplaceLabel.declare_state_and_memory()
  • ModuleWrapper
    • ModuleWrapper.generate_code()
    • ModuleWrapper.declare_state_and_memory()
• ffcv.loader module
  • Loader
    • Loader.next_traversal_order()
    • Loader.filter()
    • Loader.generate_function_call()
    • Loader.generate_stage_code()
    • Loader.generate_code()
  • OrderOption
    • OrderOption.SEQUENTIAL
    • OrderOption.RANDOM
    • OrderOption.QUASI_RANDOM
• ffcv.fields module
  • Field
    • Field.metadata_type
    • Field.from_binary()
    • Field.to_binary()
    • Field.encode()
    • Field.get_decoder_class()
  • BytesField
    • BytesField.metadata_type
    • BytesField.from_binary()
    • BytesField.to_binary()
    • BytesField.encode()
    • BytesField.get_decoder_class()
  • IntField
    • IntField.metadata_type
    • IntField.from_binary()
    • IntField.to_binary()
    • IntField.encode()
    • IntField.get_decoder_class()
  • FloatField
    • FloatField.metadata_type
    • FloatField.from_binary()
    • FloatField.to_binary()
    • FloatField.encode()
    • FloatField.get_decoder_class()
  • RGBImageField
    • RGBImageField.metadata_type
    • RGBImageField.get_decoder_class()
    • RGBImageField.from_binary()
    • RGBImageField.to_binary()
    • RGBImageField.encode()
  • NDArrayField
    • NDArrayField.metadata_type
    • NDArrayField.from_binary()
    • NDArrayField.to_binary()
    • NDArrayField.encode()
    • NDArrayField.get_decoder_class()
  • JSONField
    • JSONField.metadata_type
    • JSONField.encode()
    • JSONField.unpack()
• ffcv.fields.decoders module
  • FloatDecoder
    • FloatDecoder.dtype
  • IntDecoder
    • IntDecoder.dtype
  • NDArrayDecoder
    • NDArrayDecoder.declare_state_and_memory()
    • NDArrayDecoder.generate_code()
  • RandomResizedCropRGBImageDecoder
    • RandomResizedCropRGBImageDecoder.get_crop_generator
  • CenterCropRGBImageDecoder
    • CenterCropRGBImageDecoder.get_crop_generator
  • SimpleRGBImageDecoder
    • SimpleRGBImageDecoder.declare_state_and_memory()
    • SimpleRGBImageDecoder.generate_code()
  • BytesDecoder
    • BytesDecoder.declare_state_and_memory()
    • BytesDecoder.generate_code()