benchmark.py

import rasterio
import pathlib

from typing import Callable
from rasterio.transform import from_origin


def create_geotiff(
    fn: Callable,
    dataset_snippet: str,
    output_path: str
) -> pathlib.Path:
    """Create all the GeoTIFFs for a specific dataset snippet 

    Args:
        fn (Callable): A function that return a dictionary with the following keys:
            - "lr": Low resolution image
            - "sr": Super resolution image
            - "hr": High resolution image
        dataset_snippet (str): The dataset snippet to use to run the fn function.
        output_path (str): The output path to save the GeoTIFFs.

    Returns:
        pathlib.Path: The output path where the GeoTIFFs are saved.
    """
    pass


def run(
    model_path: str
) -> pathlib.Path:
    """Run the all metrics for a specific model.

    Args:
        model_path (str): The path to the model folder.
    
    Returns:
        pathlib.Path: The output path where the metrics are 
        saved as a pickle file.
    """
    pass


def plot(
    model_path: str
) -> pathlib.Path:
    """Generate the plots and tables for a specific model.

    Args:
        model_path (str): The path to the model folder.
    
    Returns:
        pathlib.Path: The output path where the plots and tables are 
        saved.
    """
    pass