Skip to content

Conversation

@RomeoV
Copy link
Contributor

@RomeoV RomeoV commented Sep 2, 2025

Summary

Fixes incorrect positional argument usage and string type for the status parameter in updaterun function calls.

Changes

  • Fixed docs/src/tutorial.md:112: Changed updaterun(mlf, exprun, "FINISHED") to updaterun(mlf, exprun; status=RunStatus.FINISHED)
  • Fixed examples/simple-with-mlflow.jl:61: Applied same correction

Problem

The tutorial and examples used incorrect syntax:

updaterun(mlf, exprun, "FINISHED")  # ❌ Wrong

But the actual method signature requires keyword arguments and enum types:

updaterun(instance::MLFlow, run::Run; status::Union{RunStatus.RunStatusEnum,Missing}=missing, ...)

Solution

Updated to correct syntax:

updaterun(mlf, exprun; status=RunStatus.FINISHED)  # ✅ Correct

Impact

  • Fixes MethodError that users encounter when trying to complete runs
  • Fixes type error from passing string instead of RunStatus enum
  • Makes the tutorial examples functional for run completion
  • Resolves the final step of the tutorial workflow

Test plan

  • Verified method signature using julia --project -e "using MLFlowClient; methods(updaterun)"
  • Confirmed RunStatus.FINISHED is the correct enum value
  • Both tutorial and example files updated consistently

Fixes #64

🤖 Generated with Claude Code

Fixes incorrect positional argument usage and string type for status parameter.
The updaterun function requires keyword arguments and RunStatus enum values.

Before: updaterun(mlf, exprun, "FINISHED")
After:  updaterun(mlf, exprun; status=RunStatus.FINISHED)

Fixes JuliaAI#64

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@RomeoV RomeoV mentioned this pull request Sep 3, 2025
@RomeoV
Copy link
Contributor Author

RomeoV commented Sep 3, 2025

Actually this also fails if we don't provide run_name again. This is probably a bug aswell.

@pebeto
Copy link
Member

pebeto commented Oct 13, 2025

Hi. I don't get the case of...

Actually this also fails if we don't provide run_name again. This is probably a bug aswell.

I'm approving this in terms of documentation. Thank you.

@pebeto pebeto closed this Oct 13, 2025
@pebeto pebeto reopened this Oct 13, 2025
@pebeto pebeto merged commit de48322 into JuliaAI:main Oct 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tutorial uses incorrect updaterun API syntax

2 participants