# tfdf.tuner.RandomSearch

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/decision-forests/blob/main/tensorflow_decision_forests/component/tuner/tuner.py#L218-L257) |

Tuner using random hyperparameter values.

Inherits From: [`Tuner`](https://www.tensorflow.org/decision_forests/api_docs/python/tfdf/tuner/Tuner)

    tfdf.tuner.RandomSearch(
        num_trials: int = 100,
        use_predefined_hps: bool = False,
        trial_num_threads: int = 1,
        trial_maximum_training_duration_seconds: Optional[float] = None
    )

### Used in the notebooks

| Used in the tutorials |
|---|
| - [Automated hyper-parameter tuning](https://www.tensorflow.org/decision_forests/tutorials/automatic_tuning_colab) |

The candidate hyper-parameter can be evaluated independently and in parallel.

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `num_trials` | Number of random hyperparameter values to evaluate. |
| `use_predefined_hps` | If true, automatically configure the the space of hyper-parameters explored by the tuner. In this case, configuring the hyper-parameters manually (e.g. calling "choice(...)" on the tuner) is not necessary. |
| `trial_num_threads` | Number of threads used to train the models in each trial. This parameter is different from the `num_threads` parameter of the model constructor that indicates how many threads to use for the overal training+possibly tuning. For example trial_num_threads=2 and num_threads=5, 5 models will be training in parallel during tuning, and each of those models will be trained with 2 threads. In reverse, if you want to run at most 100 threads globally, make sure that trial_num_threads\*num_threads = 100. |
| `trial_maximum_training_duration_seconds` | Maximum training duration of an individual trial expressed in seconds. This parameter is different from the maximum_training_duration_seconds parameter of the model constructor that define the maximum training+tuning duration. |

<br />

## Methods

### `choice`

[View source](https://github.com/tensorflow/decision-forests/blob/main/tensorflow_decision_forests/component/tuner/tuner.py#L194-L211)

    choice(
        key: str,
        values: Union[List[int], List[float], List[str], List[bool]],
        merge: bool = False
    ) -> SearchSpace

Adds a hyperparameter with a list of possible values.

<br />

<br />

<br />

| Args ||
|---|---|
| `key` | Name of the hyper-parameter. |
| `values` | List of possible value for the hyperparameter. |
| `merge` | If false (default), raises an error if the hyper-parameter already exist. If true, adds values to the parameter if it already exist. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| The conditional SearchSpace corresponding to the values in "values". ||

<br />

### `set_base_learner`

[View source](https://github.com/tensorflow/decision-forests/blob/main/tensorflow_decision_forests/component/tuner/tuner.py#L189-L192)

    set_base_learner(
        learner: str
    ) -> None

Sets the base learner key.

### `train_config`

[View source](https://github.com/tensorflow/decision-forests/blob/main/tensorflow_decision_forests/component/tuner/tuner.py#L184-L187)

    train_config() -> TrainConfig

YDF training configuration for the Hyperparameter optimizer.