https://github.com/tariqdaouda/spyrkle

Static documentation for your glorious pythonic work
https://github.com/tariqdaouda/spyrkle

deep-learning documentation documentation-tool notebook notes pytorch

Last synced: about 1 year ago
JSON representation

Static documentation for your glorious pythonic work

• Host: GitHub
• URL: https://github.com/tariqdaouda/spyrkle
• Owner: tariqdaouda
• License: apache-2.0
• Created: 2019-04-12T21:52:41.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-02-05T18:29:02.000Z (over 3 years ago)
• Last Synced: 2025-03-26T06:41:42.889Z (about 1 year ago)
• Topics: deep-learning, documentation, documentation-tool, notebook, notes, pytorch
• Language: JavaScript
• Size: 881 KB
• Stars: 3
• Watchers: 3
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Spyrkle

Static documentation is great because it never changes, it can be archived and sent to collegues.

There's no better way to keep a clean record of your amazing experiments and results.

Current version allows you to create paginated notebooks containing images (from urls), code and graphs (like Deep Learning models from pyTorch for example). In the future I may add support for static images and plots, and embedding in Jupyter notebooks.

**Spyrkle** is still a work in progress, full documentation will be avaiblable soon.However, if you're here for pyTorch network visualization please take a look a the demos folder. There are nice examples waiting there for you.

Contributions welcome!

# Installation

* Clone it

* Go into the Spyrkle folder

* Do *python setup.py develop*

As always it is highly recommended to install Spyrkle inside a virtual environement. Use conda, it's better.