All Implemented Interfaces:


public final class DpoHyperparameters.Builder

A builder for DpoHyperparameters.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final DpoHyperparameters.Builder`	`batchSize(DpoHyperparameters.BatchSize batchSize)`	Number of examples in each batch.
`final DpoHyperparameters.Builder`	`batchSize(JsonField<DpoHyperparameters.BatchSize> batchSize)`	Sets Builder.batchSize to an arbitrary JSON value.
`final DpoHyperparameters.Builder`	`batchSize(Long integer)`	Alias for calling batchSize with `BatchSize.ofInteger(integer)`.
`final DpoHyperparameters.Builder`	`batchSizeAuto()`	Alias for calling batchSize with `BatchSize.ofAuto()`.
`final DpoHyperparameters.Builder`	`beta(DpoHyperparameters.Beta beta)`	The beta value for the DPO method.
`final DpoHyperparameters.Builder`	`beta(JsonField<DpoHyperparameters.Beta> beta)`	Sets Builder.beta to an arbitrary JSON value.
`final DpoHyperparameters.Builder`	`beta(Double number)`	Alias for calling beta with `Beta.ofNumber(number)`.
`final DpoHyperparameters.Builder`	`betaAuto()`	Alias for calling beta with `Beta.ofAuto()`.
`final DpoHyperparameters.Builder`	`learningRateMultiplier(DpoHyperparameters.LearningRateMultiplier learningRateMultiplier)`	Scaling factor for the learning rate.
`final DpoHyperparameters.Builder`	`learningRateMultiplier(JsonField<DpoHyperparameters.LearningRateMultiplier> learningRateMultiplier)`	Sets Builder.learningRateMultiplier to an arbitrary JSON value.
`final DpoHyperparameters.Builder`	`learningRateMultiplier(Double number)`	Alias for calling learningRateMultiplier with `LearningRateMultiplier.ofNumber(number)`.
`final DpoHyperparameters.Builder`	`learningRateMultiplierAuto()`	Alias for calling learningRateMultiplier with `LearningRateMultiplier.ofAuto()`.
`final DpoHyperparameters.Builder`	`nEpochs(DpoHyperparameters.NEpochs nEpochs)`	The number of epochs to train the model for.
`final DpoHyperparameters.Builder`	`nEpochs(JsonField<DpoHyperparameters.NEpochs> nEpochs)`	Sets Builder.nEpochs to an arbitrary JSON value.
`final DpoHyperparameters.Builder`	`nEpochs(Long integer)`	Alias for calling nEpochs with `NEpochs.ofInteger(integer)`.
`final DpoHyperparameters.Builder`	`nEpochsAuto()`	Alias for calling nEpochs with `NEpochs.ofAuto()`.
`final DpoHyperparameters.Builder`	`additionalProperties(Map<String, JsonValue> additionalProperties)`
`final DpoHyperparameters.Builder`	`putAdditionalProperty(String key, JsonValue value)`
`final DpoHyperparameters.Builder`	`putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)`
`final DpoHyperparameters.Builder`	`removeAdditionalProperty(String key)`
`final DpoHyperparameters.Builder`	`removeAllAdditionalProperties(Set<String> keys)`
`final DpoHyperparameters`	`build()`	Returns an immutable instance of DpoHyperparameters.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - batchSize
```
 final DpoHyperparameters.Builder batchSize(DpoHyperparameters.BatchSize batchSize)
```
    Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.
  - batchSize
```
 final DpoHyperparameters.Builder batchSize(JsonField<DpoHyperparameters.BatchSize> batchSize)
```
    Sets Builder.batchSize to an arbitrary JSON value.
    You should usually call Builder.batchSize with a well-typed BatchSize value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - batchSize
```
 final DpoHyperparameters.Builder batchSize(Long integer)
```
    Alias for calling batchSize with BatchSize.ofInteger(integer).
  - batchSizeAuto
```
 final DpoHyperparameters.Builder batchSizeAuto()
```
    Alias for calling batchSize with BatchSize.ofAuto().
  - beta
```
 final DpoHyperparameters.Builder beta(DpoHyperparameters.Beta beta)
```
    The beta value for the DPO method. A higher beta value will increase the weight of the penalty between the policy and reference model.
  - beta
```
 final DpoHyperparameters.Builder beta(JsonField<DpoHyperparameters.Beta> beta)
```
    Sets Builder.beta to an arbitrary JSON value.
    You should usually call Builder.beta with a well-typed Beta value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - beta
```
 final DpoHyperparameters.Builder beta(Double number)
```
    Alias for calling beta with Beta.ofNumber(number).
  - betaAuto
```
 final DpoHyperparameters.Builder betaAuto()
```
    Alias for calling beta with Beta.ofAuto().
  - learningRateMultiplier
```
 final DpoHyperparameters.Builder learningRateMultiplier(DpoHyperparameters.LearningRateMultiplier learningRateMultiplier)
```
    Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.
  - learningRateMultiplier
```
 final DpoHyperparameters.Builder learningRateMultiplier(JsonField<DpoHyperparameters.LearningRateMultiplier> learningRateMultiplier)
```
    Sets Builder.learningRateMultiplier to an arbitrary JSON value.
    You should usually call Builder.learningRateMultiplier with a well-typed LearningRateMultiplier value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - learningRateMultiplier
```
 final DpoHyperparameters.Builder learningRateMultiplier(Double number)
```
    Alias for calling learningRateMultiplier with LearningRateMultiplier.ofNumber(number).
  - learningRateMultiplierAuto
```
 final DpoHyperparameters.Builder learningRateMultiplierAuto()
```
    Alias for calling learningRateMultiplier with LearningRateMultiplier.ofAuto().
  - nEpochs
```
 final DpoHyperparameters.Builder nEpochs(DpoHyperparameters.NEpochs nEpochs)
```
    The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.
  - nEpochs
```
 final DpoHyperparameters.Builder nEpochs(JsonField<DpoHyperparameters.NEpochs> nEpochs)
```
    Sets Builder.nEpochs to an arbitrary JSON value.
    You should usually call Builder.nEpochs with a well-typed NEpochs value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - nEpochs
```
 final DpoHyperparameters.Builder nEpochs(Long integer)
```
    Alias for calling nEpochs with NEpochs.ofInteger(integer).
  - nEpochsAuto
```
 final DpoHyperparameters.Builder nEpochsAuto()
```
    Alias for calling nEpochs with NEpochs.ofAuto().
  - additionalProperties
```
 final DpoHyperparameters.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
```
  - putAdditionalProperty
```
 final DpoHyperparameters.Builder putAdditionalProperty(String key, JsonValue value)
```
  - putAllAdditionalProperties
```
 final DpoHyperparameters.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
```
  - removeAdditionalProperty
```
 final DpoHyperparameters.Builder removeAdditionalProperty(String key)
```
  - removeAllAdditionalProperties
```
 final DpoHyperparameters.Builder removeAllAdditionalProperties(Set<String> keys)
```
  - build
```
 final DpoHyperparameters build()
```
    Returns an immutable instance of DpoHyperparameters.
    Further updates to this Builder will not mutate the returned instance.

Class DpoHyperparameters.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

batchSize

batchSize

batchSize

batchSizeAuto

beta

beta

beta

betaAuto

learningRateMultiplier

learningRateMultiplier

learningRateMultiplier

learningRateMultiplierAuto

nEpochs

nEpochs

nEpochs

nEpochsAuto

additionalProperties

putAdditionalProperty

putAllAdditionalProperties

removeAdditionalProperty

removeAllAdditionalProperties

build