lenskit.tuning.BasePipelineTuner
================================

.. py:class:: lenskit.tuning.BasePipelineTuner(spec, out_dir = None, rng = None)
   :canonical: lenskit.tuning._base.BasePipelineTuner

   Bases: :py:obj:`abc.ABC`


   Base class for hyperparameter tuning.

   :param spec: The tuning specification.


   .. py:attribute:: settings
      :type:  lenskit.config.TuneSettings


   .. py:attribute:: spec
      :type:  lenskit.tuning.spec.TuningSpec


   .. py:attribute:: out_dir
      :type:  pathlib.Path


   .. py:attribute:: pipe_name
      :type:  str | None


   .. py:attribute:: random_seed
      :type:  numpy.random.SeedSequence


   .. py:attribute:: iterative
      :type:  bool


   .. py:attribute:: data
      :type:  lenskit.splitting.TTSplit


   .. py:attribute:: log


   .. py:method:: set_data(train, test, *, name = None)

      Set the data to be used for tuning.



   .. py:property:: metric


   .. py:property:: mode
      :type: Literal['min', 'max']



   .. py:property:: pipeline
      :type: lenskit.pipeline.config.PipelineConfig



   .. py:method:: run()
      :abstractmethod:


      Run the tuning job, returning the results.