For the complete documentation index, see llms.txt. This page is also available as Markdown.
Jupyter Notebooks
Create your narrative and document results right alongside your code and graphics, Kyso will render everything as a beautiful data document.
Publishing Notebooks
Kyso renders Jupyter notebooks as beautiful blog posts, while maintaining any interactivity in your graphical outputs. Check out the video below to see how notebooks render on Kyso & an overview of the collaboration features available on these report types:
Jupyter Notebooks on Kyso
Any plotting library that uses a Javascript kernel in the backend will render nicely on Kyso. So any graph you make in Jupyter, using Plotly, Bokeh, Altair, etc.. will work.
Note that graphs & widgets using a python kernel are currently not supported as notebook-rendered outputs. This feature is in Kyso's roadmap however. For now you can publish these types of widgets as HTML, and they will work:
Kyso now has Google Doc-style inline commenting on Jupyter notebooks!
This was made possible by Jupyter adding unique cell ids to notebooks. Kyso leverages these ids (which are unchanging) to create comments that refer to specific cells in the report. However, only Jupyter notebooks of v4.5 and above will have cell ids by default.
If you want to upload existing notebooks of older versions without updating everything locally, you can optionally allow Kyso to apply cell ids to your notebooks.
Make sure you have installed our CLI to the latest version:
And run the following from the command line, in the directory with the target notebooks:
This will prompt you with:
Collaboration
Inline Commenting & Tasks
Users can comment directly on a specific cell on Kyso now - whether that be code input or a graphical output, just as they would on Google Docs or Notion.
You can even assign inline comments "status", thus creating a project task.
Cell Referencing
By leveraging cell ids in notebooks, we've also built Report Snippets. This is especially useful when sharing notebook reports that contain lots of graphs, and you want the receiver to hone in on a specific section of the report. Simply click on the link icon next to a cell to open up that snippet in a separate page.
Note the URL in the image below:
Users can open up the rest of the notebook in the top right of the report!
Jupyter Diffing
Users can compare changes across report versions on Jupyter-based reports, just as one would do so on Github.
On the report page, follow the link shown below:
Compare Report Versions
On the next page, select the report versions you want to compare. After a moment, the report will be rendered below and you will see changes from one version to the next highlighted, just like on Github!
Jupyter notebooks of v4.5 & above have unique cell identifiers, allowing Kyso
to add inline comments to the reports. It seems that you are using an older
version of Jupyter. If you want to allow for inline comments on your report
without updating your version of Jupyter, select 'yes' and Kyso will process all
notebooks in this push & set a random identifier automatically to all cells,
with no side effects to the content of the report(s). If you select 'no' the
notebooks will be published without cell ids.
These changes will modify your .ipynb files in your local filesystem, do you
want to continue? (y/n)
