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

Evidently integration #4918

Merged
merged 5 commits into from
Oct 18, 2023
Merged

Conversation

francesco086
Copy link
Contributor

# Evidently

DVCLive can be used to track the results
of[Evidently](https://www.evidentlyai.com/). In the following we demonstrate it
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
of[Evidently](https://www.evidentlyai.com/). In the following we demonstrate it
of [Evidently](https://www.evidentlyai.com/). In the following we demonstrate it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@@ -0,0 +1,192 @@
# Evidently

DVCLive can be used to track the results
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
DVCLive can be used to track the results
[DVCLive](/doc/dvclive) can be used to track the results

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done


We will demonstrate both, and show you how to inspect the results regardless of
your IDE. However, if you are using VSCode, we recommend using
[our awesome VSCode extension](https://marketplace.visualstudio.com/items?itemName=Iterative.dvc)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
[our awesome VSCode extension](https://marketplace.visualstudio.com/items?itemName=Iterative.dvc)
the [DVC extension for VS Code](https://marketplace.visualstudio.com/items?itemName=Iterative.dvc)

Appreciate the love but technically this is what we are supposed to call it!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Copy link
Collaborator

@dberenbaum dberenbaum left a comment

Choose a reason for hiding this comment

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

Amazing work @francesco086!

Would you mind first submitting the notebook in a PR to dvclive in the examples folder? Then you can link to it in the docs like this huggingface example.

Otherwise, I have only a few minor comments if you have time to do one more iteration:

  1. To show off the other available interfaces, you could try making tabs like in https://dvc.org/doc/start/experiments/experiment-tracking#tracking.
  2. At the top of the notebook, you might want to drop the outputs of the cells or use pip install -q so that it's easier to get to the interesting stuff.
  3. In the notebook, there are some options to show the outputs more natively. For the single experiment, you can show the plots by including notebook=True when initializing DVCLive. For multiple experiments, you could show and manipulate the table in python using dvc.api.exp_show().

@francesco086
Copy link
Contributor Author

Amazing work @francesco086!

Would you mind first submitting the notebook in a PR to dvclive in the examples folder? Then you can link to it in the docs like this huggingface example.

Otherwise, I have only a few minor comments if you have time to do one more iteration:

  1. To show off the other available interfaces, you could try making tabs like in https://dvc.org/doc/start/experiments/experiment-tracking#tracking.
  2. At the top of the notebook, you might want to drop the outputs of the cells or use pip install -q so that it's easier to get to the interesting stuff.
  3. In the notebook, there are some options to show the outputs more natively. For the single experiment, you can show the plots by including notebook=True when initializing DVCLive. For multiple experiments, you could show and manipulate the table in python using dvc.api.exp_show().

Thanks @dberenbaum ! Done all you suggested except for point 1.
I could do that, but

  1. I must confess I find those gif pretty hard to understand, they are too small...
  2. if you really insist on that, I need hints on the tools to use to record the video to make an animated gif, I have never done such things before...

For the same reason as above (pictures too large to fit in the webpage), I preferred to leave the native jupyter output in the notebook itself, without putting them in the md. However I added hints on how to do that. Let me know if that is ok, or you prefer otherwise.

One last thing: I noticed that colab allows to save a copy of the notebook directly in github. Could you perhaps store it directly in the example folder, since you probably have the rights to do so?
Once you have done it I can update the colab link.

@dberenbaum
Copy link
Collaborator

Thanks @dberenbaum ! Done all you suggested except for point 1. I could do that, but

1. I must confess I find those gif pretty hard to understand, they are too small...

2. if you really insist on that, I need hints on the tools to use to record the video to make an animated gif, I have never done such things before...

For the same reason as above (pictures too large to fit in the webpage), I preferred to leave the native jupyter output in the notebook itself, without putting them in the md. However I added hints on how to do that. Let me know if that is ok, or you prefer otherwise.


No problem, we can go ahead and update in the future if needed. Good feedback on the gif size. If you have other ideas how to show the equivalent workflow in VS Code/Studio, let me know.

One last thing: I noticed that colab allows to save a copy of the notebook directly in github. Could you perhaps store it directly in the example folder, since you probably have the rights to do so? Once you have done it I can update the colab link.

Do you mind submitting a PR to the dvclive repo with this notebook saved in the examples folder? That way, you will get the credit for 2 contributions, and it better reflects the real workflow, plus we can review the actual notebook contents if needed.

@francesco086
Copy link
Contributor Author

No problem, we can go ahead and update in the future if needed. Good feedback on the gif size. If you have other ideas how to show the equivalent workflow in VS Code/Studio, let me know.

I must confess that I have no clue. Perhaps a youtube video would be a better option because it can be enlarged.
However, all of these options are very time consuming and are very hard to maintain (potentially each update could require to re-record the video). What I would do for my own repo is to keep such videos to the bare minimum, as I can't see a way to automate their creation.

Do you mind submitting a PR to the dvclive repo with this notebook saved in the examples folder? That way, you will get the credit for 2 contributions, and it better reflects the real workflow, plus we can review the actual notebook contents if needed.

Didn't think of the notebook review, here you go: iterative/dvclive#723

@dberenbaum
Copy link
Collaborator

Thanks again @francesco086, great work!

@dberenbaum dberenbaum merged commit 9ec8fa0 into iterative:main Oct 18, 2023
3 checks passed
@github-actions
Copy link
Contributor

Link Check Report

There were no links to check!

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

Successfully merging this pull request may close these issues.

2 participants