vivyd.data.Study

class Study(*, name, info)

Bases: Container

A class representing a study within the dataset. A study is a collection of experiments that are related to a specific topic. For example, a study could be focused on a parameter sweep, thus implying several experiments.

Parameters:

• name (str)

• info (dict[str, Any])

Methods

Study.add(*obj)

Add one or more studies to the study.

Parameters:

*obj (Study | Experiment) – One or more study or experiment objects to add to the study.

Returns:

The study with the added contents.

Return type:

Study