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

vdk-jupyter: changes on diagrams and definition in notebook-plugin section in VEP #1427

Merged
merged 5 commits into from
Dec 14, 2022

Conversation

duyguHsnHsn
Copy link
Collaborator

These changes are required because of some changes of the structure of the notebook-plugin during the development and to provide a better definition of what a NotebookStep defines.

Signed-off-by: Duygu Hasan hduygu@vmware.com

@duyguHsnHsn duyguHsnHsn merged commit 36807f1 into main Dec 14, 2022
@duyguHsnHsn duyguHsnHsn deleted the person/hduygu/jupyter-vep branch December 14, 2022 11:40
As it can be seen from the below diagram the plugin will consist of a new hook and a few new classes.

![vdk-notebook-plugin](vdk-notebook-plugin.png)
![vdk-notebook-plugin](vdk-notebook-plugin.jpeg)
Copy link
Collaborator

Choose a reason for hiding this comment

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

How are those pictures produced? I strongly encourage including the "source" so that someone else can edit them if they find a mistake. Or maybe if they want to re-use them and extend them for another VEP for example.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sadly, the tool I am using does not allow such "sharing". But I can put its link, of course. If you have any recommendations for another tool which can provide such sharing of the source would be amazing :)

Copy link
Collaborator

Choose a reason for hiding this comment

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

What tool are you using ? What is the link? If I can reproduce it from that link and edit it. This is fine.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I use the free version of https://lucid.app . But you cannot reproduce it.

Copy link
Collaborator

Choose a reason for hiding this comment

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

You can publish it (There's publish button) and include the link as a comment <!-- link --> in the VEP next to the image.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, but I cannot share everything since there is a limit of 3 documents for the free version. I currently have only one of them as lucid document, others are deleted after work and only the images are saved.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I can still link the one I have but I don't think it is ok for long term use since there can be added more images.

@@ -27,6 +27,7 @@ useful for a wide audience.

* VDK: https://github.com/vmware/versatile-data-kit/wiki/dictionary#vdk
* Notebook: A .ipynb file.
* Notebook cell: a multiline text input field
Copy link
Collaborator

Choose a reason for hiding this comment

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

For external terms. Link to the defintion. This seems to have come from https://jupyter-notebook.readthedocs.io/en/stable/notebook.html#structure-of-a-notebook-document
So add a link

Notebook cell: a multiline text input field ([defined in details here](https://jupyter-notebook.readthedocs.io/en/stable/notebook.html#structure-of-a-notebook-document))

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I will add it with the next change on VEP

Copy link
Collaborator

@antoniivanov antoniivanov left a comment

Choose a reason for hiding this comment

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

I see it's merged. I made some small comments but looks good to me.

I am interested in finding out what is the development experience though ?

So I open a new notebook and start writing - SQL cell and execute, then python cell, execute it, then vdk run cell . It should keep the state of the job run in memory. Would this work after installing the plugin
Or is that part of the responsibility of another component?

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

Successfully merging this pull request may close these issues.

None yet

6 participants