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

Web UI - stage1, readonly part #606

Merged
merged 50 commits into from
Dec 16, 2024
Merged

Web UI - stage1, readonly part #606

merged 50 commits into from
Dec 16, 2024

Conversation

VukW
Copy link
Contributor

@VukW VukW commented Jul 23, 2024

Adds a local web UI to use instead of CLI UI.

On this stage, only read-only views are implemented:

  • list of benchmarks
  • list of mlcubes
  • list of datasets
  • benchmark detail
  • mlcube detail
  • dataset detail

To run

medperf web-ui run [--port 8100]

# open http://localhost:8100/

TODOs & bugs up to this moment

  • common
    • move date_format function to some common place and use everywhere
    • p1 build a unified render mlcube-as-a-link and use everywhere (benchmark's cubes, dataset's dataprep cube):
      • [strong] mlcube name [small] modified date [state icon] + colored in red if invalid?
    • p1 hide None links
    • p0 bug, no scrolling on main container (say, lists)
    • p1 catch exceptions and display error
    • p2 dark theme
    • p1 Bug, navigation is hidden when the page is too narrow
    • p3 use downloaded js packages (bootstrap etc.) instead of direct link?
  • code
    • p1 getting invalid entities raises an exception now
    • p0 add templates & js to wheel package
  • MLCube detailed page
    • show tarball and additional data always
    • p2 check it works with local cubes
    • p3 add mlcube name to title
    • p1 list of associated benchmarks + assoc status
  • Dataset detailed page
    • p2 fix dataprep cube link render, see point higher ^^^
    • p1 is_valid: make a badge?
    • p2 Submitted as prepared: make a badge?
    • p3 what to do with owner: None? Show a hint over it describing why it's unknown?
    • p3 check it works with local datasets
    • p3 add dataset name to title
    • p1 list of associations + status
    • p2 add metadatas
  • Benchmark detailed page
    • p2 fix cube links render, see point higher ^^^
    • p2 add benchmark name to title
    • p1 list of associated datasets + assoc status
    • p2 number of associated datasets
  • MLCube list page
    • p2 redesign cards
    • p1 list my entities on the top
    • p2 add valid filter
    • p2 add mine filter
    • p3 check it works with local cubes
  • Bencmark list page
    • p2 redesign cards
    • p1 list my entities on the top
    • p2 add valid filter
    • p2 add mine filter
  • Datasets list page
    • p2 redesign cards
    • p1 list my entities on the top
    • p2 add valid filter
    • p2 add mine filter
    • p3 check it works with local datasets
    • add location field label

@VukW VukW requested a review from a team as a code owner July 23, 2024 09:41
@VukW VukW had a problem deploying to testing-external-code July 23, 2024 09:41 — with GitHub Actions Failure
Copy link
Contributor

github-actions bot commented Jul 23, 2024

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

@VukW
Copy link
Contributor Author

VukW commented Jul 23, 2024

Current state:

MLCubes list

image

Datasets list

image

Benchmark list

image

MLCube detailed page

image

Benchmark detailed page

image

Dataset detailed page

image

@VukW VukW had a problem deploying to testing-external-code July 23, 2024 12:04 — with GitHub Actions Failure
@VukW VukW had a problem deploying to testing-external-code July 24, 2024 17:15 — with GitHub Actions Failure
@VukW VukW had a problem deploying to testing-external-code July 24, 2024 18:19 — with GitHub Actions Failure
@VukW VukW had a problem deploying to testing-external-code August 13, 2024 17:13 — with GitHub Actions Failure
@VukW VukW had a problem deploying to testing-external-code August 14, 2024 16:54 — with GitHub Actions Failure
@VukW VukW had a problem deploying to testing-external-code August 14, 2024 17:30 — with GitHub Actions Failure
@VukW VukW had a problem deploying to testing-external-code August 26, 2024 15:25 — with GitHub Actions Failure
@VukW VukW changed the title [WIP] Web UI Web UI - stage1, readonly part Aug 26, 2024
@VukW VukW had a problem deploying to testing-external-code August 27, 2024 07:00 — with GitHub Actions Failure
@VukW VukW had a problem deploying to testing-external-code August 27, 2024 07:01 — with GitHub Actions Failure
VukW added 2 commits August 27, 2024 17:54
# Conflicts:
#	cli/medperf/commands/list.py
#	cli/medperf/entities/benchmark.py
#	cli/medperf/entities/cube.py
#	cli/medperf/entities/dataset.py
#	cli/medperf/entities/interface.py
@VukW VukW had a problem deploying to testing-external-code August 28, 2024 16:32 — with GitHub Actions Failure
@VukW VukW had a problem deploying to testing-external-code September 17, 2024 10:29 — with GitHub Actions Failure
This was referenced Sep 30, 2024
@VukW VukW had a problem deploying to testing-external-code October 9, 2024 14:13 — with GitHub Actions Failure
@aristizabal95 aristizabal95 changed the base branch from main to web-ui December 16, 2024 17:08
Copy link
Contributor

@aristizabal95 aristizabal95 left a comment

Choose a reason for hiding this comment

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

This is looking good! There is a little bit of repeated code in the FastAPI routers for listing objects, but is manageable and something that can be improved later on

<link rel="stylesheet" href="/static/css/font-awesome-5.15.4-all.min.css">
<!-- https://cdnjs.cloudflare.com/ajax/libs/prism/1.23.0/themes/prism.min.css -->
<link rel="stylesheet" href="/static/css/prism-1.23.0.min.css">
<style>
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a way to put this in a separate css file? It feels like this has too much content to be inserted as an inline style instruction

@aristizabal95 aristizabal95 merged commit 01e4617 into mlcommons:web-ui Dec 16, 2024
5 of 8 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Dec 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants