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.

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

Rename pipeline parameters for better organization on the DSP run page #125

Open
MichaelClifford opened this issue Oct 24, 2024 · 1 comment · May be fixed by #181
Open

Rename pipeline parameters for better organization on the DSP run page #125

MichaelClifford opened this issue Oct 24, 2024 · 1 comment · May be fixed by #181
Assignees

Comments

@MichaelClifford
Copy link
Collaborator

MichaelClifford commented Oct 24, 2024

There are a lot of parameters needed for the ilab pipeline, and they are each individually relevant to the SDG, Training or Eval steps. However, the parameter names provide no hint to the users as to what part of the pipeline they control. Furthermore, DSP automatically displays them in alphabetical order. This is simply confusing and not a good user experience. See image below for an example.

We should rename all the params with an appropriate prefix (sdg_, train_, eval_mtbench_, and eval_final_) so that they will be group logically on the "Create Run" page.

Screenshot 2024-10-24 at 10 48 29 AM
@tumido
Copy link
Member

tumido commented Nov 7, 2024

I addition we can use the docstring parser of the DSL to populate description. It's not much but it can help.

https://www.kubeflow.org/docs/components/pipelines/user-guides/components/additional-functionality/#component-docstring-format

@dsl.pipeline(display_name='Test pipeline')
def pipeline(
    sdg_foo: str,
    train_baz: str,
):
    """This is a test pipeline.

    Args:
        sdg_foo: This is an SDG parameter Foo that does Bar.
        train_baz: This is a Training parameter Baz that does Qux.

    """
    ...

Which translates to IR YAML:

pipelineInfo:
  description: This is a test pipeline.
  displayName: Test pipeline
  name: pipeline
root:
  dag:
    ...
  inputDefinitions:
    parameters:
      sdg_foo:
        description: This is an SDG parameter Foo that does Bar.
        parameterType: STRING
      train_baz:
        description: This is a Training parameter Baz that does Qux.
        parameterType: STRING

Which is surfaced as following in RHOAI:

image

@tumido tumido self-assigned this Nov 15, 2024
@tumido tumido linked a pull request Nov 15, 2024 that will close this issue
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 a pull request may close this issue.

2 participants