.FastAI.DatasetsDatasetRecipe

			abstract type DatasetRecipe

A recipe that contains configuration for loading a data container. Calling it with a path returns a data container and the blocks that each sample is made of.

Examples

For example implementations, see FastVision.ImageFolders.

Extending

Interface

• loadrecipe (::DatasetRecipe, args...; kwargs...) -> (data, blocks) This loads a data container the [ Block]s that each observation corresponds to. For most recipes the only argument beside the recipe is a path to a folder on disk.

• recipeblocks (::Type{DatasetRecipe}) -> TBlocks The type of blocks returned by loadrecipe. Should be as specific as possible. Used for discovery.

Invariants

Given

			
			
			
			
			data
			,
			 
			blocks
			 
			=
			 
			
			loadrecipe
			(
			recipe
			,
			 
			
			args
			...
			
			;
			 
			
			kwargs
			...
			)

the following must hold:

• ∀i ∈ 1:numobs(data): checkblock(blocks, data[i]), i.e. data must be a data container of observations that are valid blocks.

• numobs(data) ≥ 1, i.e. there is at least one observation if the data was loaded without error.