Skip to content

Tutorial uses incorrect updaterun API syntax #64

@RomeoV

Description

@RomeoV

Description

The tutorial uses incorrect syntax for the updaterun function, passing status as a positional string argument when it should be a keyword argument with a RunStatus enum value.

Location

  • docs/src/tutorial.md:112

Issue

Tutorial shows:

updaterun(mlf, exprun, "FINISHED")

But the actual method signature requires keyword arguments:

updaterun(instance::MLFlow, run::Run; status, end_time, run_name)

Additionally, the status parameter expects a RunStatus enum value, not a string.

Impact

  • Users following the tutorial will encounter MethodError: no method matching updaterun(..., ::String)
  • The tutorial fails when trying to complete the experiment run
  • This prevents proper cleanup and run finalization

Expected Behavior

Tutorial should show the correct syntax:

updaterun(mlf, exprun; status=FINISHED)

Where FINISHED is the RunStatus.FINISHED enum value (exported from MLFlowClient).

Actual Behavior

Tutorial shows incorrect positional argument syntax with wrong type (string instead of enum).

Environment

  • MLFlowClient.jl version: 0.6.0
  • Julia version: 1.11.6

Found via systematic API analysis using methods(updaterun) to verify method signatures against tutorial usage.

Related

This is part of a broader pattern of API inconsistencies in the tutorial documentation that make the examples non-functional.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions