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

Refactor ExperimentListView using @databricks/design-system's Tree component #5829

Merged
merged 14 commits into from
May 12, 2022

Conversation

harupy
Copy link
Member

@harupy harupy commented May 8, 2022

Signed-off-by: harupy hkawamura0130@gmail.com

What changes are proposed in this pull request?

Refactor the ExperimentListView component using @databricks/design-system's Tree component to simplify the implementation of multi-experiment run comparison in #5822.

ExperimentListView-refactor.mov

How is this patch tested?

  • Unit tests
  • Manual QA

Does this PR change the documentation?

  • No. You can skip the rest of this section.
  • Yes. Make sure the changed pages / sections render correctly by following the steps below.
  1. Check the status of the ci/circleci: build_doc check. If it's successful, proceed to the
    next step, otherwise fix it.
  2. Click Details on the right to open the job page of CircleCI.
  3. Click the Artifacts tab.
  4. Click docs/build/html/index.html.
  5. Find the changed pages / sections and make sure they render correctly.

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

(Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.)

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/artifacts: Artifact stores and artifact logging
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages
  • area/examples: Example code
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/projects: MLproject format, project running backends
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/server-infra: MLflow Tracking server backend
  • area/tracking: Tracking Service, tracking client APIs, autologging

Interface

  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
  • area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
  • area/windows: Windows support

Language

  • language/r: R APIs and clients
  • language/java: Java APIs and clients
  • language/new: Proposals for new client languages

Integrations

  • integrations/azure: Azure and Azure ML integrations
  • integrations/sagemaker: SageMaker integrations
  • integrations/databricks: Databricks integrations

How should the PR be classified in the release notes? Choose one:

  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

@github-actions github-actions bot added area/uiux Front-end, user experience, plotting, JavaScript, JavaScript dev server rn/none List under Small Changes in Changelogs. labels May 8, 2022
Comment on lines +203 to +217
selectable: true,
multiple: true,
selectedKeys: [activeExperimentId],
titleRender: this.renderListItem,
Copy link
Member Author

@harupy harupy May 8, 2022

Choose a reason for hiding this comment

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

To support multi-experiment run comparison, we can add checkable and onCheck:

Suggested change
selectable: true,
multiple: true,
selectedKeys: [activeExperimentId],
titleRender: this.renderListItem,
checkable: true,
selectable: true,
multiple: true,
onCheck: this.handleCheck,
selectedKeys: [activeExperimentId],
titleRender: this.renderListItem,

Ref: https://ant.design/components/tree/

Copy link
Member Author

Choose a reason for hiding this comment

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

Quick demo:

multi-experiment-demo.mov

@harupy harupy changed the title Refactor ExperimentListView using @databricks/design-system Refactor ExperimentListView using @databricks/design-system's Tree component May 8, 2022
@harupy harupy force-pushed the refactor-ExperimentListView branch from 842c4f7 to 9d8d8dd Compare May 9, 2022 11:14
@harupy harupy mentioned this pull request May 9, 2022
29 tasks
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
@harupy harupy force-pushed the refactor-ExperimentListView branch from b30d3f7 to a5075d7 Compare May 10, 2022 04:13
Signed-off-by: harupy <hkawamura0130@gmail.com>
@harupy
Copy link
Member Author

harupy commented May 10, 2022

Testing scroll when we have many experiments:

many-experiments.mov

Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Comment on lines 107 to 117
<div
style={{
width: '180px',
overflow: 'hidden',
textOverflow: 'ellipsis',
whiteSpace: 'nowrap',
}}
onClick={this.onSelect(key)}
>
{title}
</div>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there a reason we don't use LinkTo here and rather use div? This isn't great for a11y as well since the screen readers wouldn't read it as Link and note that there would a transition. Plus tracking things like site-speed is difficult where we rely on navigation or something.

Copy link
Member Author

Choose a reason for hiding this comment

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

@sunishsheth2009

Is there a reason we don't use LinkTo here and rather use div?

No, we can replace this div with <Link to=... >.

Signed-off-by: harupy <hkawamura0130@gmail.com>
@harupy harupy merged commit c3216a9 into mlflow:master May 12, 2022
@harupy harupy deleted the refactor-ExperimentListView branch May 12, 2022 01:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/uiux Front-end, user experience, plotting, JavaScript, JavaScript dev server rn/none List under Small Changes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants