Skip to content

Tutorial uses incorrect createexperiment API syntax #62

@RomeoV

Description

@RomeoV

Description

The tutorial uses incorrect syntax for the createexperiment function, passing name as a keyword argument when it should be positional.

Location

  • docs/src/tutorial.md:75

Issue

Tutorial shows:

experiment_id = createexperiment(mlf; name="price-paths")

But the actual method signature requires name as a positional argument:

createexperiment(instance::MLFlow, name::String; artifact_location, tags)

Impact

  • Users following the tutorial will encounter MethodError: no method matching createexperiment
  • The tutorial example fails at the very first MLFlow operation
  • This breaks the main learning path for new users

Expected Behavior

Tutorial should show the correct syntax:

experiment_id = createexperiment(mlf, "price-paths")

Actual Behavior

Tutorial shows incorrect keyword argument syntax that causes method dispatch errors.

Environment

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

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

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