Skip to content

File Path Utils

Source

Module containing file path utilities for WriteStrategy to use.

create_write_file_path(dirpath, file_path, write_extension)

Create the file name for the output file.

Takes the original file path, changes the directory to dirpath and changes the extension to write_extension.

Parameters:

Name Type Description Default
dirpath Path

The output directory to write file to.

required
file_path Path

The original file path.

required
write_extension str

The extension that output files should have.

required

Returns:

Type Description
Path

The output file path.

get_sample_file_path(dataset, sample_id)

Get the file path for a particular sample.

Parameters:

Name Type Description Default
dataset IterableTiledPredDataset or IterablePredDataset

Dataset.

required
sample_id int

Sample ID, the index of the file in the dataset dataset.

required

Returns:

Type Description
Path

The file path corresponding to the sample with the ID sample_id.