The repository that contains all source code for the ZenML UI.

Overview

Logo

Open-source companion dashboard for ZenML.

Manage and visualize your ML pipelines, stacks and artifacts in one place.
Explore the docs »

Join our Slack Slack Community and be part of the ZenML family.

Features · Roadmap · Report Bug · Vote New Features · Read Blog · Meet the Team
🎉 Version 0.1.0 is out. Check out the release notes here.

Logo Logo

🏁 Table of Contents
  1. Getting Started
  2. 🏄 User Experience
  3. 🙌 Contributing
  4. 👩‍👩‍👧‍👦 Meet the Team
  5. 🆘 Getting Help
  6. 📜 License

Getting Started

🔋 Installation

The installation is as follows:

First, there is a pre-requisite to use node version 14.20.0 exactly. One can do this by installing the nvm utility and then doing

nvm install 14.20.0
nvm use 14.20.0

Users also need to have yarn installed.

Then you can run it by doing:

yarn install
yarn start

To build it:

yarn build

The app takes the following env variables:

REACT_APP_BASE_API_URL="<YOUR_ZENML_SERVER_DEPOLOYMENT_URL>/api/v1"

To learn how to get the YOUR_ZENML_SERVER_DEPOLOYMENT_URL, read the deployment guide.

Lastly, if you would like to use Docker, then the ZenML team provides [DockerHub] images to serve the ZenML Server and Dashboard in one image:

docker run -it -d -p 8080:80 zenmldocker/zenml-server

Which will serve the dashboard with the server at http://localhost:8080, with username default and an empty password.

👨‍👦 Relationship with ZenML

The ZenML Dashboard is a Javascript React-based application that lives inside this repository, which is a sister repository of the main ZenML Python package repo.

Note - The ZenML Dashboard is meant to be used with the ZenML Server as a backend and cannot be used standalone.

The dashboard build files come bundled into the ZenML PyPi package and can be served locally and/or deployed on the cloud through the main ZenML python package.

Basically, each ZenML Python package comes with the build files (generated by yarn build) of a certain version of this dashboard (all build files of the dashboard can be seen in the releases section of this GitHub repo). Therefore, each ZenML PyPi package has bundled in it a corresponding version of this dashboard.

With the Python package, you can then serve these static build files by doing:

zenml up

img

Which creates a local daemon that serves the files in a FastAPI server!

🪐 Deploying the dashboard

You can deploy this dashboard on supported cloud providers with ZenML python package by using the command:

zenml deploy

The above command deploys the dashboard in the same process as the ZenML Server, and automates a lot of the nitty gritties for you.

However, the option to deploy standalone is also available. yarn build creates a build directory with a production build of the dashboard. Set up your favorite HTTP server so that a visitor to your site is served index.html. Here are 8 ways to deploy a React app for free as a starting point.

Just don't forget to the set the REACT_APP_BASE_API_URL environment variable!

🏄 User Experience

?? Log In

img

🏠 Home Page

img

🗂 Pipelines, Stacks and Components

img

🙌 Contributing

We would love to develop ZenML together with our community! Best way to get started is to select any issue from the good-first-issue label.

If you would like to contribute, please review our Contributing Guide for all relevant details.

👩‍👩‍👧‍👦 Meet the Team

Meet the Team

Every week, the ZenML core team will pop in for 30 minutes to interact directly with the community. Sometimes we'll be presenting a feature, other times we'll take questions and have fun.

Register now for the ZenML Meet the Community session. It's free and open to everyone.

Or subscribe to our public events calendar to get notified before every community gathering.

🆘 Getting Help

By far the easiest and fastest way to get a response is to:

  1. Ask your questions in our Slack group.
  2. Open an issue on our GitHub repo.

📜 License

ZenML Dashboard is distributed under the terms of the Apache License Version 2.0. A complete version of the license is available in the LICENSE file in this repository. Any contribution made to this project will be licensed under the Apache License Version 2.0.

You might also like...

This repository contains an Advanced Zoom Apps Sample. It should serve as a starting point for you to build and test your own Zoom App in development.

Advanced Zoom Apps Sample Advanced Sample covers most complex scenarios that you might be needed in apps. App has reference implementation for: Authen

Dec 17, 2022

This repository contains different infrastructure components that are used in different projects here at NaN Labs.

Infrastructure Reference Changelog | Contributing This repository contains different infrastructure components that are used in different projects her

Dec 15, 2022

The repository shows the compiler (simulator) of the Little Man Computer, which also contains some programs in the LMC programming language for implementing different functions.

Little Man Computer The repository shows the compiler (simulator) of the Little Man Computer, which also contains some programs in the LMC programming

Nov 17, 2022

This repository contains a fullstack chatbot project based on the ChatGPT `gpt-3.5-turbo` model.

This is a fullstack chatbot created with React, Nodejs, OpenAi, and ChatGPT while developing the following tutorial: How To Build A Chat Bot Applicati

May 10, 2023

🚀👩‍🚀This repo contains all the files to follow along and implement a MultiChain NFT MarketPlace! Be sure to watch my Youtube tutorials so you can learn and follow along!

🚀👩‍🚀This repo contains all the files to follow along and implement a MultiChain NFT MarketPlace! Be sure to watch my Youtube tutorials so you can learn and follow along!

Multi-Chain NFT Marketplace 🚀 👩‍🚀 This repo contains all the files to follow along and implement a MultiChain NFT MarketPlace! Be sure to watch my

Jan 5, 2023

Encode WEB-Dev is a open source project which contains different projects of Html, CSS, Javascript and MERN Stack etc.

HACKTOBERFEST 2022 Encode WEB-Dev is an open source project which contains different projects of Html, CSS, Javascript and MERN Stack etc. which makes

Oct 31, 2022

This is email scheduler made using MERN. This repo contains server code, client repo is linked in readme.

Email Scheduler Client This is an email scheduler server (client in different repository). It is made using node.js/express.js. Overview User can sign

Dec 3, 2022

This monorepo stores all code and assets of all projects with which we develop regels.overheid.nl

Welcome Introduction In 2021 Utrecht started developing the Virtual Income Desk with Open Rules. An initiative with the aim for citizens to always and

Dec 8, 2022
Releases(v0.1.5)
Owner
ZenML
Building production MLOps tooling.
ZenML
Hemsida för personer i Sverige som kan och vill erbjuda boende till människor på flykt

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

null 4 May 3, 2022
Kurs-repo för kursen Webbserver och Databaser

Webbserver och databaser This repository is meant for CME students to access exercises and codealongs that happen throughout the course. I hope you wi

null 14 Jan 3, 2023
Jaime Gómez-Obregón 119 Dec 24, 2022
SAP Community Code Challenge: This repository contains an empty OpenUI5 application and end-to-end tests written with wdi5. Take part in the challenge and develop an app that passes the tests.

SAP Community Code Challenge - UI5 The change log describes notable changes in this package. Description This repository is the starting point for the

SAP Samples 8 Oct 24, 2022
This project contains a leader board for a game which contains players name and list and store them on API build with HTML, CSS, JS and API

Leaderboard This App is a Game Leaderboard app Which is created by JavaScript and the big picture of this application is using API. Build With ??‍?? .

Sahar Saba Amiri 5 Dec 15, 2022
Hacktoberfest is all about meeting up all brains. In this repository we are planning to come with many ideas and works. You all can share your ides/works here.

Hacktoberfest Submit your Work Hacktoberfest is all about meeting up all brains. In this repository we are planning to come with many ideas and works.

Chinmay Patil 3 Oct 5, 2022
The repository contains the list of awesome✨ & cool web development beginner-friendly✌️ projects!

Web-dev-mini-projects The repository contains the list of awesome ✨ & cool web development beginner-friendly ✌️ projects! Web-dev-mini-projects ADD AN

Ayush Parikh 265 Jan 3, 2023
This repository contains a basic example on how to set up and run test automation jobs with CircleCI and report results to Testmo.

CircleCI test automation example This repository contains a basic example on how to set up and run test automation jobs with CircleCI and report resul

Testmo 2 Dec 23, 2021
Example-browserstack-reporting - This repository contains an example of running Selenium tests and reporting BrowserStack test results, including full CI pipeline integration.

BrowserStack reporting and Selenium test result example This repository contains an example of running Selenium tests and reporting BrowserStack test

Testmo 1 Jan 1, 2022
This repository contains the Solidity smart contract of Enso, a detailed list of features and deployment instructions.

Enso NFT Smart Contract This repository contains the Solidity smart contract of Enso, a detailed list of features and deployment instructions. We stro

enso NFT 3 Apr 24, 2022