diff --git a/js/src/logger.ts b/js/src/logger.ts index e350e417..7368e46e 100644 --- a/js/src/logger.ts +++ b/js/src/logger.ts @@ -1093,7 +1093,7 @@ type InitializedExperiment = * * @param options Options for configuring init(). * @param options.project The name of the project to create the experiment in. Must specify at least one of `project` or `projectId`. - * @param options.experiment The name of the experiment to create. If not specified, a name will be generated automatically. + * @param options.experiment The name of the experiment to create. If not specified, a name will be generated automatically. If you use an existing experiment name, by default it will create a new experiment with that name as a prefix. If you want to update an existing experiment, you can set `options.update: true`. If you want to open an existing experiment in read-only mode, you can set `options.open: true`. * @param options.description An optional description of the experiment. * @param options.dataset (Optional) A dataset to associate with the experiment. You can pass in the name of the dataset (in the same project) or a dataset object (from any project). * @param options.update If the experiment already exists, continue logging to it. diff --git a/py/src/braintrust/logger.py b/py/src/braintrust/logger.py index 6a0c355b..03e4ea26 100644 --- a/py/src/braintrust/logger.py +++ b/py/src/braintrust/logger.py @@ -678,7 +678,7 @@ def init( Log in, and then initialize a new experiment in a specified project. If the project does not exist, it will be created. :param project: The name of the project to create the experiment in. Must specify at least one of `project` or `project_id`. - :param experiment: The name of the experiment to create. If not specified, a name will be generated automatically. + :param experiment: The name of the experiment to create. If not specified, a name will be generated automatically. If you use an existing experiment name, by default it will create a new experiment with that name as a prefix. If you want to update an existing experiment, you can set `update=True`. If you want to open an existing experiment in read-only mode, you can set `open=True`. :param description: (Optional) An optional description of the experiment. :param dataset: (Optional) A dataset to associate with the experiment. The dataset must be initialized with `braintrust.init_dataset` before passing it into the experiment.