Class JobCreateParams.Integration.Wandb
-
- All Implemented Interfaces:
public final class JobCreateParams.Integration.Wandb
The settings for your integration with Weights and Biases. This payload specifies the project that metrics will be sent to. Optionally, you can set an explicit display name for your run, add tags to your run, and set a default entity (team, username, etc) to be associated with your run.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
JobCreateParams.Integration.Wandb.Builder
A builder for Wandb.
-
Method Summary
Modifier and Type Method Description final String
project()
The name of the project that the new run will be created under. final Optional<String>
entity()
The entity to use for the run. final Optional<String>
name()
A display name to set for the run. final Optional<List<String>>
tags()
A list of tags to be attached to the newly created run. final JsonField<String>
_project()
Returns the raw JSON value of project. final JsonField<String>
_entity()
Returns the raw JSON value of entity. final JsonField<String>
_name()
Returns the raw JSON value of name. final JsonField<List<String>>
_tags()
Returns the raw JSON value of tags. final Map<String, JsonValue>
_additionalProperties()
final JobCreateParams.Integration.Wandb.Builder
toBuilder()
final JobCreateParams.Integration.Wandb
validate()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static JobCreateParams.Integration.Wandb.Builder
builder()
Returns a mutable builder for constructing an instance of Wandb. -
-
Method Detail
-
entity
final Optional<String> entity()
The entity to use for the run. This allows you to set the team or username of the WandB user that you would like associated with the run. If not set, the default entity for the registered WandB API key is used.
-
name
final Optional<String> name()
A display name to set for the run. If not set, we will use the Job ID as the name.
-
tags
final Optional<List<String>> tags()
A list of tags to be attached to the newly created run. These tags are passed through directly to WandB. Some default tags are generated by OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".
-
_project
final JsonField<String> _project()
Returns the raw JSON value of project.
Unlike project, this method doesn't throw if the JSON field has an unexpected type.
-
_entity
final JsonField<String> _entity()
Returns the raw JSON value of entity.
Unlike entity, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_tags
final JsonField<List<String>> _tags()
Returns the raw JSON value of tags.
Unlike tags, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final JobCreateParams.Integration.Wandb.Builder toBuilder()
-
validate
final JobCreateParams.Integration.Wandb validate()
-
builder
final static JobCreateParams.Integration.Wandb.Builder builder()
Returns a mutable builder for constructing an instance of Wandb.
The following fields are required:
.project()
-
-
-
-