lenskit.tuning.spec.TuningSpec
==============================

.. py:class:: lenskit.tuning.spec.TuningSpec
   

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


   Data model for hyperparameter tuning specifications.


   .. py:method:: load(path)
      :classmethod:



   .. py:attribute:: file_path
      :type:  Annotated[pathlib.Path | None, Field(exclude=True)]
      :value: None


      The path to the spec file.


   .. py:attribute:: search
      :type:  SearchConfig

      Options for the hyperparameter search.


   .. py:attribute:: space
      :type:  dict[str, SearchSpace]

      The search space for tuning.


   .. py:attribute:: pipeline
      :type:  PipelineFile | lenskit.pipeline.config.PipelineConfig

      The pipeline to tune.


   .. py:property:: component_name
      :type: str | None


      Get the name of the tuned component, if the search specifies
      parameters for a single component.


   .. py:method:: resolve_path(path)

      Resolve a path relative to this specification's file.