Class: Braintrust::Models::Experiment

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/braintrust/models/experiment.rb

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #initialize, #inspect, #to_h, #to_s

Constructor Details

This class inherits a constructor from Braintrust::BaseModel

Instance Attribute Details

#base_exp_id ⇒ String

Id of default base experiment to compare against when viewing this experiment

Returns:

  • (String) 


29
 
# File 'lib/braintrust/models/experiment.rb', line 29

optional :base_exp_id, String

#commit ⇒ String

Commit, taken directly from repo_info.commit

Returns:

  • (String) 


34
 
# File 'lib/braintrust/models/experiment.rb', line 34

optional :commit, String

#created ⇒ DateTime

Date of experiment creation

Returns:

  • (DateTime) 


39
 
# File 'lib/braintrust/models/experiment.rb', line 39

optional :created, DateTime

#dataset_id ⇒ String

Identifier of the linked dataset, or null if the experiment is not linked to a dataset

Returns:

  • (String) 


44
 
# File 'lib/braintrust/models/experiment.rb', line 44

optional :dataset_id, String

#dataset_version ⇒ String

Version number of the linked dataset the experiment was run against. This can be used to reproduce the experiment after the dataset has been modified.

Returns:

  • (String) 


49
 
# File 'lib/braintrust/models/experiment.rb', line 49

optional :dataset_version, String

#deleted_at ⇒ DateTime

Date of experiment deletion, or null if the experiment is still active

Returns:

  • (DateTime) 


54
 
# File 'lib/braintrust/models/experiment.rb', line 54

optional :deleted_at, DateTime

#description ⇒ String

Textual description of the experiment

Returns:

  • (String) 


59
 
# File 'lib/braintrust/models/experiment.rb', line 59

optional :description, String

#id ⇒ String

Unique identifier for the experiment

Returns:

  • (String) 


9
 
# File 'lib/braintrust/models/experiment.rb', line 9

required :id, String

#metadata ⇒ Hash

User-controlled metadata about the experiment

Returns:

  • (Hash) 


64
 
# File 'lib/braintrust/models/experiment.rb', line 64

optional :metadata, Hash

#name_ ⇒ String

Name of the experiment. Within a project, experiment names are unique

Returns:

  • (String) 


14
 
# File 'lib/braintrust/models/experiment.rb', line 14

required :name_, String

#project_id ⇒ String

Unique identifier for the project that the experiment belongs under

Returns:

  • (String) 


19
 
# File 'lib/braintrust/models/experiment.rb', line 19

required :project_id, String

#public ⇒ Boolean

Whether or not the experiment is public. Public experiments can be viewed by anybody inside or outside the organization

Returns:

  • (Boolean) 


24
 
# File 'lib/braintrust/models/experiment.rb', line 24

required :public, Braintrust::BooleanModel

#repo_info ⇒ Braintrust::Models::RepoInfo

Metadata about the state of the repo when the experiment was created

Returns:



69
 
# File 'lib/braintrust/models/experiment.rb', line 69

optional :repo_info, -> { Braintrust::Models::RepoInfo }

#user_id ⇒ String

Identifies the user who created the experiment

Returns:

  • (String) 


74
 
# File 'lib/braintrust/models/experiment.rb', line 74

optional :user_id, String