hyrax.verbs.create_splits
=========================

.. py:module:: hyrax.verbs.create_splits


Attributes
----------

.. autoapisummary::

   hyrax.verbs.create_splits.logger


Classes
-------

.. autoapisummary::

   hyrax.verbs.create_splits.CreateSplits


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

.. py:data:: logger

.. py:class:: CreateSplits(config)

   Bases: :py:obj:`hyrax.verbs.verb_registry.Verb`


   Create and persist reproducible dataset splits.

   .. py:method:: __init__

   Overall initialization for all verbs that saves the config


   .. py:attribute:: cli_name
      :value: 'create_splits'



   .. py:attribute:: add_parser_kwargs


   .. py:attribute:: description
      :value: 'Compute and persist dataset splits for reproducible training workflows.'



   .. py:attribute:: REQUIRED_DATA_GROUPS
      :value: ()



   .. py:attribute:: OPTIONAL_DATA_GROUPS
      :value: ()



   .. py:method:: setup_parser(parser)
      :staticmethod:


      No additional CLI options needed.



   .. py:method:: run_cli(args=None)

      CLI stub for CreateSplits verb.



   .. py:method:: run()

      Compute dataset splits and write them to a results directory.

      Reads the ``[split]`` and ``[balance]`` config tables to determine how to
      partition each data group, then persists ``.npz`` index files and a
      ``split_config.toml`` under a timestamped ``*-splits-*`` results directory.
      Subsequent verbs (``train``, ``infer``, ``test``) can point at this directory
      to reuse the same split without recomputing it.

      :returns: The populated dataset providers, keyed by group name.
      :rtype: dict[str, DataProvider]