EvSys
Apievsys_sdkstore

EvsysStore

Attributes

attributebase_url
= (base_url or os.environ.get(EVSYS_API_URL_ENV) or DEFAULT_API_URL).rstrip('/')
attributeapi_key
= api_key or os.environ.get(EVSYS_API_KEY_ENV)
attributeproject_id
= project_id or os.environ.get(EVSYS_PROJECT_ID_ENV)
attributetimeout_s
= timeout_s

Functions

func__init__(self, *, base_url=None, api_key=None, project_id=None, timeout_s=DEFAULT_TIMEOUT_S) -> None
paramself
parambase_urlstr | None
= None
paramapi_keystr | None
= None
paramproject_idstr | None
= None
paramtimeout_sfloat
= DEFAULT_TIMEOUT_S

Returns

None
func_call(self, op, **args) -> Any
paramself
paramopstr
paramargsAny
= {}

Returns

typing.Any
func_project(self, project_id) -> str | None
paramself
paramproject_idstr | None

Returns

str | None
funccreate_project(self, name, *, description=None, organization_id=None) -> dict
paramself
paramnamestr
paramdescriptionstr | None
= None
paramorganization_idstr | None
= None

Returns

dict
funcget_project(self, project_id=None) -> dict | None
paramself
paramproject_idstr | None
= None

Returns

dict | None
funcdelete_project(self, project_id=None) -> Any
paramself
paramproject_idstr | None
= None

Returns

typing.Any
funcset_goal(self, goal, *, project_id=None) -> dict
paramself
paramgoalstr
paramproject_idstr | None
= None

Returns

dict
funclist_goals(self, project_id=None) -> list[dict]
paramself
paramproject_idstr | None
= None

Returns

list[dict]
funccurrent_goal(self, project_id=None) -> dict | None
paramself
paramproject_idstr | None
= None

Returns

dict | None
funccreate_experiment(self, *, experiment_name, project_id=None, hypothesis=None, project_goal_id=None, tags=None, **extra) -> dict
paramself
paramexperiment_namestr
paramproject_idstr | None
= None
paramhypothesisstr | None
= None
paramproject_goal_idstr | None
= None
paramtagslist[str] | None
= None
paramextraAny
= {}

Returns

dict
funcget_experiment(self, experiment_id) -> dict | None
paramself
paramexperiment_idstr

Returns

dict | None
funcupdate_experiment(self, experiment_id, **patch) -> dict
paramself
paramexperiment_idstr
parampatchAny
= {}

Returns

dict
funcset_conclusion(self, experiment_id, conclusion) -> dict
paramself
paramexperiment_idstr
paramconclusionstr

Returns

dict
funcinvalidate_experiment(self, experiment_id, *, reason=None) -> dict
paramself
paramexperiment_idstr
paramreasonstr | None
= None

Returns

dict
funclist_experiments(self, project_id=None, *, valid_only=False) -> list[dict]
paramself
paramproject_idstr | None
= None
paramvalid_onlybool
= False

Returns

list[dict]
funcdelete_experiment(self, experiment_id) -> Any
paramself
paramexperiment_idstr

Returns

typing.Any
funcexperiment_summaries(self, project_id=None, *, valid_only=False) -> list[dict]
paramself
paramproject_idstr | None
= None
paramvalid_onlybool
= False

Returns

list[dict]
funcexperiment_detail(self, experiment_id, *, include_metrics=False) -> dict
paramself
paramexperiment_idstr
paraminclude_metricsbool
= False

Returns

dict
funccreate_group(self, experiment_id, name, *, description=None) -> dict
paramself
paramexperiment_idstr
paramnamestr
paramdescriptionstr | None
= None

Returns

dict
funclist_groups(self, experiment_id) -> list[dict]
paramself
paramexperiment_idstr

Returns

list[dict]
funccreate_run(self, *, experiment_id, group_id=None, dataset_id=None, seed=None, recipe_kind=None, run_config=None, status='pending', **extra) -> dict
paramself
paramexperiment_idstr
paramgroup_idstr | None
= None
paramdataset_idstr | None
= None
paramseedint | None
= None
paramrecipe_kindstr | None
= None
paramrun_configdict | None
= None
paramstatusstr
= 'pending'
paramextraAny
= {}

Returns

dict
funcget_run(self, run_id) -> dict | None
paramself
paramrun_idstr

Returns

dict | None
funcupdate_run(self, run_id, **patch) -> dict
paramself
paramrun_idstr
parampatchAny
= {}

Returns

dict
funclist_runs(self, *, experiment_id=None, group_id=None) -> list[dict]
paramself
paramexperiment_idstr | None
= None
paramgroup_idstr | None
= None

Returns

list[dict]
funccreate_dataset(self, *, name, format, project_id=None, version=1, source_kind=None, transform=None, storage_uri=None, metadata=None) -> dict
paramself
paramnamestr
paramformatstr
paramproject_idstr | None
= None
paramversionint
= 1
paramsource_kindstr | None
= None
paramtransformlist | None
= None
paramstorage_uristr | None
= None
parammetadatadict | None
= None

Returns

dict
funcadd_dataset_rows(self, dataset_id, rows, *, start_idx=0) -> list[dict]
paramself
paramdataset_idstr
paramrowslist[dict]
paramstart_idxint
= 0

Returns

list[dict]
funcget_dataset(self, dataset_id) -> dict | None
paramself
paramdataset_idstr

Returns

dict | None
funclist_datasets(self, project_id=None) -> list[dict]
paramself
paramproject_idstr | None
= None

Returns

list[dict]
funcget_dataset_rows(self, dataset_id, *, limit=100, offset=0) -> list[dict]
paramself
paramdataset_idstr
paramlimitint
= 100
paramoffsetint
= 0

Returns

list[dict]
funccreate_benchmark(self, *, name, format, project_id=None, version=1, source_kind=None, transform=None, storage_uri=None, metadata=None) -> dict
paramself
paramnamestr
paramformatstr
paramproject_idstr | None
= None
paramversionint
= 1
paramsource_kindstr | None
= None
paramtransformlist | None
= None
paramstorage_uristr | None
= None
parammetadatadict | None
= None

Returns

dict
funcadd_benchmark_rows(self, benchmark_id, rows, *, start_idx=0) -> list[dict]
paramself
parambenchmark_idstr
paramrowslist[dict]
paramstart_idxint
= 0

Returns

list[dict]
funcget_benchmark(self, benchmark_id) -> dict | None
paramself
parambenchmark_idstr

Returns

dict | None
funclist_benchmarks(self, project_id=None) -> list[dict]
paramself
paramproject_idstr | None
= None

Returns

list[dict]
funcget_benchmark_rows(self, benchmark_id, *, limit=100, offset=0) -> list[dict]
paramself
parambenchmark_idstr
paramlimitint
= 100
paramoffsetint
= 0

Returns

list[dict]
funcadd_checkpoint(self, *, run_id, uri, label=None, step=None, base_model=None, is_final=False) -> dict
paramself
paramrun_idstr
paramuristr
paramlabelstr | None
= None
paramstepint | None
= None
parambase_modelstr | None
= None
paramis_finalbool
= False

Returns

dict
funclist_checkpoints(self, run_id) -> list[dict]
paramself
paramrun_idstr

Returns

list[dict]
funccreate_eval(self, *, run_id, benchmark_id=None, checkpoint_id=None, model_ref=None, step=None, metrics=None, breakdowns=None, sdk_version=None) -> dict
paramself
paramrun_idstr
parambenchmark_idstr | None
= None
paramcheckpoint_idstr | None
= None
parammodel_refstr | None
= None
paramstepint | None
= None
parammetricsdict | None
= None
parambreakdownsdict | None
= None
paramsdk_versionstr | None
= None

Returns

dict
funclist_evals(self, run_id) -> list[dict]
paramself
paramrun_idstr

Returns

list[dict]
funcadd_prediction(self, *, run_id, kind, eval_id=None, task_id=None, instruction=None, model_output=None, expected=None, reward=None, advantage=None, step=None, sample_idx=0, metadata=None) -> dict
paramself
paramrun_idstr
paramkindstr
parameval_idstr | None
= None
paramtask_idstr | None
= None
paraminstructionstr | None
= None
parammodel_outputstr | None
= None
paramexpectedAny
= None
paramrewardfloat | None
= None
paramadvantagefloat | None
= None
paramstepint | None
= None
paramsample_idxint
= 0
parammetadatadict | None
= None

Returns

dict
funclist_predictions(self, run_id, *, kind=None) -> list[dict]
paramself
paramrun_idstr
paramkindstr | None
= None

Returns

list[dict]
funclog_metric(self, *, run_id, step, name, value, split='train') -> dict
paramself
paramrun_idstr
paramstepint
paramnamestr
paramvaluefloat
paramsplitstr
= 'train'

Returns

dict
funclog_metrics(self, *, run_id, step, metrics, split='train') -> list[dict]
paramself
paramrun_idstr
paramstepint
parammetricsdict[str, float]
paramsplitstr
= 'train'

Returns

list[dict]
funcget_metrics(self, run_id, *, name=None, split=None) -> list[dict]
paramself
paramrun_idstr
paramnamestr | None
= None
paramsplitstr | None
= None

Returns

list[dict]

store

Previous Page

EvsysStoreError

Next Page

On this page

AttributesFunctions