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

Jump to bottom

Improve documentation clarity for tags variable and update type in function definition. #52

Merged
merged 2 commits into from
Nov 2, 2024
Merged

Improve documentation clarity for tags variable and update type in function definition. #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30946be
Clarify `tags` documentation and update type definition
vonpetersenn Jun 5, 2024
869886e
Improve documentation clarity for `tags` variable
vonpetersenn Jun 14, 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
6 changes: 4 additions & 2 deletions src/experiments.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ Creates an MLFlow experiment.
- `mlf`: [`MLFlow`](@ref) configuration.
- `name`: experiment name. If not specified, MLFlow sets it.
- `artifact_location`: directory where artifacts of this experiment will be stored. If not specified, MLFlow uses its default configuration.
- `tags`: a Dictionary of key-values which tag the experiment.
- `tags`: a Vector of Dictionaries which tag the experiment.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pebeto Is this really the way this works?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @ablaom. Yes, tags must be a Vector of Dictionaries with key and value, as expected in mlflow (i.e. https://mlflow.org/docs/latest/rest-api.html?highlight=tags#experimenttag).

Copy link
Member

@pebeto pebeto Jun 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also is good to mention that I'm working on the next big change for this library (9fe5e9a), where I'm pairing everything with the last mlflow specification (including types).

Copy link
Member

@ablaom ablaom Jun 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This just seems weird. If I want to assign the value "bar" to a tag called "foo", and a value "gala" to a tag called "missy", I would have expected to pass Dict("foo" => "bar", "missy" => "gala"). But my reading of the proposed doc clarification is different: I should pass [Dict("key" => "foo", "value" => "bar"), Dict("key" => "missy", "value" => "gala")] instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also found it counterintuitive, which is why I opened the pull request.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right. Then I'll leave to @pebeto to finalise the review. Perhaps we can make this more intuitive at the next breaking release.

- example tags: [Dict("key" => "foo", "value" => "bar"), Dict("key" => "missy", "value" => "gala")]

# Returns
An object of type [`MLFlowExperiment`](@ref).
Expand Down Expand Up @@ -97,7 +98,8 @@ Gets an experiment if one alrady exists, or creates a new one.
- `mlf`: [`MLFlow`](@ref) configuration.
- `experiment_name`: Experiment name.
- `artifact_location`: directory where artifacts of this experiment will be stored. If not specified, MLFlow uses its default configuration.
- `tags`: a Dictionary of key-values which tag the experiment.
- `tags`: a Vector of Dictionaries which tag the experiment.
- example tags: [Dict("key" => "foo", "value" => "bar"), Dict("key" => "missy", "value" => "gala")]

# Returns
An instance of type [`MLFlowExperiment`](@ref)
Expand Down
3 changes: 2 additions & 1 deletion src/runs.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ Creates a run associated to an experiment.
# Keywords
- `run_name`: run name. If not specified, MLFlow sets it.
- `start_time`: if provided, must be a UNIX timestamp in milliseconds. By default, set to current time.
- `tags`: if provided, must be a key-value structure such as a dictionary.
- `tags`: if provided, must be a key-value structure such as for example:
- [Dict("key" => "foo", "value" => "bar"), Dict("key" => "missy", "value" => "gala")]

# Returns
- an instance of type [`MLFlowRun`](@ref)
Expand Down
Loading