czbenchmarks.file_cache
=======================

.. py:module:: czbenchmarks.file_cache

.. autoapi-nested-parse::

   File caching utilities for remote storage operations.

   This module provides functions for caching datasets and model outputs to/from remote storage,
   primarily AWS S3. It includes functionality for downloading, uploading, and managing cached
   processed datasets.



Attributes
----------

.. autoapisummary::

   czbenchmarks.file_cache.log


Classes
-------

.. autoapisummary::

   czbenchmarks.file_cache.CacheOptions


Module Contents
---------------

.. py:data:: log

.. py:class:: CacheOptions(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   Configuration options for caching datasets and model outputs.

   .. attribute:: download_embeddings

      Whether to download embeddings from the remote cache.

      :type: bool

   .. attribute:: upload_embeddings

      Whether to upload embeddings to the remote cache.

      :type: bool

   .. attribute:: upload_results

      Whether to upload results to the remote cache.

      :type: bool

   .. attribute:: remote_cache_url

      URL of the remote cache.

      :type: str

   Create a new model by parsing and validating input data from keyword arguments.

   Raises [`ValidationError`][pydantic_core.ValidationError] if the input data cannot be
   validated to form a valid model.

   `self` is explicitly positional-only to allow `self` as a field name.


   .. py:attribute:: download_embeddings
      :type:  bool


   .. py:attribute:: upload_embeddings
      :type:  bool


   .. py:attribute:: upload_results
      :type:  bool


   .. py:attribute:: remote_cache_url
      :type:  str


   .. py:method:: from_args(args: argparse.Namespace) -> CacheOptions
      :classmethod: