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

Improve Kedro-Viz documentation for Experiment Tracking #1241

Closed
stichbury opened this issue Dec 20, 2022 · 5 comments
Closed

Improve Kedro-Viz documentation for Experiment Tracking #1241

stichbury opened this issue Dec 20, 2022 · 5 comments
Assignees

Comments

@stichbury
Copy link
Contributor

stichbury commented Dec 20, 2022

This issue is to track the work on the third and final page of the Kedro-Viz section of docs which discusses Experiment Tracking.: https://kedro.readthedocs.io/en/stable/visualisation/experiment_tracking.html

There are a raft of changes/improvements coming and this ticket should cover any rework of the docs to include those.

I suggest that we revise the page to make it more of a tutorial in experiment tracking (maybe taking the Spaceflights starter and extending, but it could be a separate example). We could potentially create a separate page for information about using the experiment tracking feature, and keep the tutorial about it separate. Let's see how much copy there is as the page is currently too long.

@stichbury
Copy link
Contributor Author

Tagging @NeroOkwa for visibility and extra information/feedback

@stichbury
Copy link
Contributor Author

stichbury commented Jan 4, 2023

Also to do:

@tynandebold
Copy link
Member

tynandebold commented Jan 9, 2023

Highest priority items:

  • Ensure that the spaceflights tutorial works without issue. There was a problem with Plotly where the charts weren't rendering (relates to Make Kedro-Viz work with kedro-datasets #1205).
  • There are actually two pages for exp. tracking documentation. We should only have one.
    • Copy the contents of the second, smaller page into the first and then delete that content from the second page.
  • Mention parallel coordinate and time-series plots.

These items are covered in kedro-org/kedro#2193.

@tynandebold
Copy link
Member

tynandebold commented Jan 18, 2023

@stichbury the related PR (kedro-org/kedro#2193) is now merged. What do you want to do with this issue? Is there more to do or shall we close it?

@stichbury
Copy link
Contributor Author

We can close it. Thanks @tynandebold!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Status: Done
Development

No branches or pull requests

3 participants