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.

Sign up for GitHub

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

Updates hamilton UI docs with video #879

Merged
merged 1 commit into from
May 2, 2024
Merged

Updates hamilton UI docs with video #879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/concepts/ui.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ If you'd like a video walkthrough on getting set up, you can watch the following

<iframe width="560" height="315" src="https://www.youtube.com/embed/DPfxlTwaNsM?si=gks5oOAWsNPSJbe_" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

If you'd like a quick overview of some of the features, you can watch the following:

.. raw:: html

<iframe width="560" height="315" src="https://www.youtube.com/embed/0VIVSeN7Ij8?si=i3vTsfTNorzh5y2C" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

Getting Started
---------------

Expand Down
14 changes: 8 additions & 6 deletions examples/hamilton_ui/run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@


@click.command()
@click.option("--load-from-parquet", is_flag=False)
@click.option(
"--load-from-parquet", is_flag=True, help="Load from saved parquet or load fresh dataset."
)
@click.option("--email", help="Email for the Hamilton UI", type=str, required=True)
@click.option(
"--project-id", help="Project ID to log to for the Hamilton UI", type=int, required=True
Expand All @@ -17,12 +19,12 @@ def run(load_from_parquet: bool, email: str, project_id: int):
"""
Runs the machine_learning hamilton DAG emitting metadata to the Hamilton UI.

Prerequisite:
- You need to have the Hamilton UI running.
Prerequisite - you need to have the Hamilton UI running:

cd hamilton/ui/deployment # directory with docker files

./run.sh # will start docker

:param load_from_parquet: If true, the DAG will not be logged to DAGWorks
:param email: Email for the Hamilton UI
:param project_id: Project ID to log to for the Hamilton UI
"""
if load_from_parquet:
config = {"case": "parquet"}
Expand Down
4 changes: 4 additions & 0 deletions ui/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ The Hamilton UI is a system that provides the following capabilities:
The UI is meant to monitor/debug Hamilton dataflows both in **development** and **production**. The aim is to enable
dataflow authors to move faster during all phases of the software development lifecycle.

For an overview of some of these features [you can watch this quick video](https://youtu.be/0VIVSeN7Ij8?si=maeV0zdzTPSqUl1N).

### Execution Tracking

<p align="center">
Expand Down Expand Up @@ -61,6 +63,8 @@ dataflow authors to move faster during all phases of the software development li

## Getting started

You can watch this [video walkthrough on getting set up](https://youtu.be/DPfxlTwaNsM).

Make sure you have docker running:
```bash
# clone the repository if you haven't
Expand Down