Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update experiment param docs #193

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update experiment param docs #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
388fcf6
update JS SDK param options.experiment docs
robertguss Apr 17, 2024
643f0cd
update JS and Python SDK experiment param docs
robertguss Apr 17, 2024
97deb0f
revert auto formatting
robertguss Apr 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion js/src/logger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1093,7 +1093,7 @@ type InitializedExperiment<IsOpen extends boolean | undefined> =
*
* @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.
Expand Down
2 changes: 1 addition & 1 deletion py/src/braintrust/logger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading