Skip to content

Commit

Permalink
Release TF-DF 1.1.0 and YDF 1.2.0
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 489482890
  • Loading branch information
rstz authored and copybara-github committed Nov 18, 2022
1 parent a694e81 commit b604f92
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

## HEAD
## 1.2.0 - 2022-11-18

### Features

Expand Down
49 changes: 49 additions & 0 deletions documentation/learners.md
Original file line number Diff line number Diff line change
Expand Up @@ -1251,3 +1251,52 @@ learner hyper-parameters.
- If true, workers will print training logs.

</font>

## HYPERPARAMETER_OPTIMIZER

<font size="2">

### Training configuration

Following are the protobuffer definitions used in TrainingConfiguration to set
learner hyper-parameters.

- <a href="../yggdrasil_decision_forests/learner/abstract_learner.proto">learner/abstract_learner.proto</a>

### Generic Hyper-parameters

#### [maximum_model_size_in_memory_in_bytes](../yggdrasil_decision_forests/learner/abstract_learner.proto?q=symbol:maximum_model_size_in_memory_in_bytes)

- **Type:** Real **Default:** -1

- Limit the size of the model when stored in ram. Different algorithms can
enforce this limit differently. Note that when models are compiled into an
inference, the size of the inference engine is generally much smaller than
the original model.

#### [maximum_training_duration_seconds](../yggdrasil_decision_forests/learner/abstract_learner.proto?q=symbol:maximum_training_duration_seconds)

- **Type:** Real **Default:** -1

- Maximum training duration of the model expressed in seconds. Each learning
algorithm is free to use this parameter at it sees fit. Enabling maximum
training duration makes the model training non-deterministic.

#### [pure_serving_model](../yggdrasil_decision_forests/learner/abstract_learner.proto?q=symbol:pure_serving_model)

- **Type:** Categorical **Default:** false **Possible values:** true, false

- Clear the model from any information that is not required for model serving.
This includes debugging, model interpretation and other meta-data. The size
of the serialized model can be reduced significatively (50% model size
reduction is common). This parameter has no impact on the quality, serving
speed or RAM usage of model serving.

#### [random_seed](../yggdrasil_decision_forests/learner/abstract_learner.proto?q=symbol:random_seed)

- **Type:** Integer **Default:** 123456

- Random seed for the training of the model. Learners are expected to be
deterministic by the random seed.

</font>
49 changes: 49 additions & 0 deletions documentation/rtd/hyper_parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -1269,3 +1269,52 @@ learner hyper-parameters.
- If true, workers will print training logs.

</font>

## HYPERPARAMETER_OPTIMIZER

<font size="2">

### Training configuration

Following are the protobuffer definitions used in TrainingConfiguration to set
learner hyper-parameters.

- <a href="https://github.com/google/yggdrasil-decision-forests/blob/main/yggdrasil_decision_forests/learner/abstract_learner.proto">learner/abstract_learner.proto</a>

### Generic Hyper-parameters

#### [maximum_model_size_in_memory_in_bytes](https://github.com/google/yggdrasil-decision-forests/blob/main/yggdrasil_decision_forests/learner/abstract_learner.proto)

- **Type:** Real **Default:** -1

- Limit the size of the model when stored in ram. Different algorithms can
enforce this limit differently. Note that when models are compiled into an
inference, the size of the inference engine is generally much smaller than
the original model.

#### [maximum_training_duration_seconds](https://github.com/google/yggdrasil-decision-forests/blob/main/yggdrasil_decision_forests/learner/abstract_learner.proto)

- **Type:** Real **Default:** -1

- Maximum training duration of the model expressed in seconds. Each learning
algorithm is free to use this parameter at it sees fit. Enabling maximum
training duration makes the model training non-deterministic.

#### [pure_serving_model](https://github.com/google/yggdrasil-decision-forests/blob/main/yggdrasil_decision_forests/learner/abstract_learner.proto)

- **Type:** Categorical **Default:** false **Possible values:** true, false

- Clear the model from any information that is not required for model serving.
This includes debugging, model interpretation and other meta-data. The size
of the serialized model can be reduced significatively (50% model size
reduction is common). This parameter has no impact on the quality, serving
speed or RAM usage of model serving.

#### [random_seed](https://github.com/google/yggdrasil-decision-forests/blob/main/yggdrasil_decision_forests/learner/abstract_learner.proto)

- **Type:** Integer **Default:** 123456

- Random seed for the training of the model. Learners are expected to be
deterministic by the random seed.

</font>

0 comments on commit b604f92

Please sign in to comment.