deepboard 0.1.0__tar.gz → 0.2.0__tar.gz

deepboard-0.2.0/.gitignore

@@ -0,0 +1,171 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# MacOS
+.DS_Store
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+tmp.py
+
+results/
+
+.sesskey
+
+tmp*

{deepboard-0.1.0 → deepboard-0.2.0}/PKG-INFO

@@ -1,36 +1,27 @@
 Metadata-Version: 2.4
 Name: deepboard
-Version: 0.1.0
-Summary: A tool to log you experiment results and explore them in a gui
-Home-page: https://github.com/anthol42/deepboard
-Author: Anthony Lavertu
-Author-email: alavertu2@gmail.com
+Version: 0.2.0
+Summary: Organize your research project like a pro with Deepboard
+Project-URL: Homepage, https://github.com/anthol42/deepboard
 Project-URL: Issues, https://github.com/anthol42/deepboard/issues
-Keywords: deepboard,deep,board,pytorch,torch,tensorflow,jax,tensorboard
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Operating System :: MacOS
+Author-email: Anthony Lavertu <alavertu2@gmail.com>
+Keywords: board,deep,deepboard,jax,pytorch,tensorboard,tensorflow,torch
 Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Science/Research
 Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: python-fasthtml
-Requires-Dist: fh-plotly
-Requires-Dist: MarkupSafe
+Requires-Python: >=3.10
+Requires-Dist: matplotlib
 Requires-Dist: pandas
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
+Requires-Dist: pillow
+Provides-Extra: full
+Requires-Dist: fh-plotly; extra == 'full'
+Requires-Dist: markupsafe; extra == 'full'
+Requires-Dist: python-fasthtml; extra == 'full'
+Description-Content-Type: text/markdown
 
 # Deepboard
 This package include two modules that are work together: 
@@ -41,10 +32,13 @@ implement a webUI to visualize the training details and training
 curves of any runs. In addition, it lets you commpare training curves
 between runs. You can even download the charts that you have generated:)
 ## 🔥 Screenshots 🔥
-![](https://raw.githubusercontent.com/anthol42/deepboard/main/assets/main_view.png)
+![](./assets/main_view.png)
+
+
+![](./assets/compare_view.png)
 
 
-![](https://raw.githubusercontent.com/anthol42/deepboard/main/assets/compare_view.png)
+![](./assets/full_table_view.png)
 ## 🌟 Project Philosophy
 Before diving in, it’s important to understand the philosophy behind this project. In deep learning, it’s easy to get 
 swept up in the excitement — experimenting with countless configurations in search of the perfect setup. 🔬✨ 
@@ -100,10 +94,16 @@ If you're feeling a bit overwhelmed or would like a project example, the
 default template implements this philosophy, including the resultTable, making it a great starting point! 🚀
 
 ## 🛠️ Installation
+To install only the `resultTable` module, which allows you to log your results inside a single file, you can run:
 ```shell
 pip install deepboard
 ```
 
+To also install the `GUI` module, which allows you to visualize your results in a web UI, you can run:
+```shell
+pip install deepboard[full]
+```
+
 ## 🚀 How to Use
 For your project, you will only need the `resultTable` module, as the `deepboard` module is primarily for the UI.
 
@@ -161,4 +161,4 @@ resultSocket.write_result(accuracy=accuracies.mean(), crossEntropy=losses.mean()
 To launch deepboard Web UI, simply run the command `deepboard` in your terminal with the path to your resultTable db:
 ```shell
 deepboard /path/to/resultTable.db
-```
+```

{deepboard-0.1.0 → deepboard-0.2.0}/README.md

@@ -11,6 +11,9 @@ between runs. You can even download the charts that you have generated:)
 
 
 ![](./assets/compare_view.png)
+
+
+![](./assets/full_table_view.png)
 ## 🌟 Project Philosophy
 Before diving in, it’s important to understand the philosophy behind this project. In deep learning, it’s easy to get 
 swept up in the excitement — experimenting with countless configurations in search of the perfect setup. 🔬✨ 
@@ -66,10 +69,16 @@ If you're feeling a bit overwhelmed or would like a project example, the
 default template implements this philosophy, including the resultTable, making it a great starting point! 🚀
 
 ## 🛠️ Installation
+To install only the `resultTable` module, which allows you to log your results inside a single file, you can run:
 ```shell
 pip install deepboard
 ```
 
+To also install the `GUI` module, which allows you to visualize your results in a web UI, you can run:
+```shell
+pip install deepboard[full]
+```
+
 ## 🚀 How to Use
 For your project, you will only need the `resultTable` module, as the `deepboard` module is primarily for the UI.
 

deepboard-0.2.0/deepboard/__version__.py

@@ -0,0 +1,4 @@
+# This file is auto-generated by Hatchling. As such, do not:
+#   - modify
+#   - track in version control e.g. be sure to add to .gitignore
+__version__ = VERSION = '0.2.0'

deepboard-0.2.0/deepboard/gui/assets/artefacts.css

@@ -0,0 +1,108 @@
+/*
+This css file contains classes for all artefacts tabs:
+- Images
+- Figures
+- Text
+- Html fragments
+ */
+
+.artefact-split-select{
+    appearance: none;
+    background-color: inherit;
+    color: var(--sp-color);
+    border: none;
+    /*border-bottom: var(--artefacts-split-option-border);*/
+    padding-left: 36px;
+    padding-right: 24px;
+    margin-bottom: 0;
+    font-size: 1.75em;
+    font-weight: bold;
+    outline: none;
+    transition: border 0.1s ease, box-shadow 0.1s ease;
+    cursor: pointer;
+
+    background-image: url("data:image/svg+xml;charset=US-ASCII,%3Csvg xmlns='http://www.w3.org/2000/svg' width='14' height='10' viewBox='0 0 14 10'%3E%3Cpath fill='%23ccc' d='M7 10L0 0h14z'/%3E%3C/svg%3E");
+    background-repeat: no-repeat;
+    background-position: left 10px center;
+    background-size: 12px;
+}
+.artefact-split-option{
+    /* Empty for now */
+}
+
+.artefact-stats-column{
+    /* Nothing here yet */
+}
+
+.artefact-card-header{
+    display: flex;
+    flex-direction: row;
+    width: 100%;
+    justify-content: space-between;
+    padding-bottom: 1em;
+    border-bottom: var(--artefacts-header-line)
+}
+
+.artefact-card{
+    background-color: var(--artefacts-card-bg);
+    box-shadow: var(--artefacts-card-shadow);
+    padding: 1em;
+    border-radius: var(--artefacts-card-radius);
+    display: flex;
+    flex-direction: column;
+    /*Margin top: 1em and bottom: 1em. 0 otherwise*/
+    margin-bottom: 2em;
+}
+
+.artefact-group-container{
+    margin-top: 1em;
+    display: flex;
+    flex-direction: row;
+    flex-wrap: wrap;
+    gap: 1em;
+    justify-content: space-evenly;
+}
+
+
+.image{
+  width: var(--artefacts-image_size);
+  height: var(--artefacts-image_size);
+  display: inline-block;
+  overflow: hidden;
+}
+
+.interactive-image-container{
+    width: 92vw;
+    height: 100vh;
+    overflow: hidden;
+    margin: 20px auto;
+    background: inherit;
+}
+.interactive-image{
+    width: 100%;
+    height: 100%;
+    /*transition: transform 0.1s ease;*/
+    transform-origin: center center;
+}
+
+.interactive-image img {
+    object-fit: contain;
+    display: block;
+}
+
+.fragment-text-container {
+    background-color: var(--fv-bg);
+    padding: 1em;
+    border-radius: 0.25em;
+    overflow: auto;
+    width: 100%;
+}
+
+.fragment-text{
+    margin: 0;
+    padding: 0.5em;
+    font-size: 0.8rem;
+    color: var(--artefacts-text-color);
+    font-family: var(--artefacts-text-font), monospace;
+    white-space: pre-wrap;
+}

{deepboard-0.1.0 → deepboard-0.2.0}/deepboard/gui/assets/base.css

@@ -82,9 +82,11 @@ body {
 
 
 .copy-container {
+  width: 100%;
   position: relative;
   display: inline-flex;
   align-items: center;
+  justify-content: space-between;
   gap: 8px;
   cursor: pointer;
   padding: 0;
@@ -165,4 +167,42 @@ body {
   display: flex;
   justify-content: center; /* Horizontal centering */
   align-items: center;     /* Vertical centering */
+}
+
+.expand {
+  display: flex;
+  width: 100%;
+  justify-content: space-between;
+}
+
+img {
+  object-fit: contain;
+  width: 100%;
+  height: 100%;
+    /* Scale without interpolation */
+  image-rendering: pixelated;          /* Modern browsers */
+  image-rendering: -moz-crisp-edges;   /* Firefox fallback */
+  image-rendering: crisp-edges;        /* Webkit fallback */
+}
+
+.modal-overlay{
+    position: fixed;
+    top: 0;
+    left: 0;
+    width: 100vw;
+    height: 100vh;
+    background-color: rgba(0, 0, 0, 0.75);
+    z-index: 999; /* Ensure it covers other content */
+}
+.modal-overlay.hidden{
+  display: none;
+}
+.modal{
+  width: 100%;
+  height: 100%;
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  /* Center content vertically */
+  align-items: center;
 }

{deepboard-0.1.0 → deepboard-0.2.0}/deepboard/gui/assets/right_panel.css

@@ -36,8 +36,8 @@
     display: flex;
     height: 100%;
     width: 100%;
-    justify-content: left;
-    padding-left: 4rem;
+    max-width: 49vw;
+    justify-content: right;
     padding-top: 2rem;
 }
 
@@ -52,6 +52,8 @@ margin: 0;
   display: flex;
   margin-bottom: 0;
   margin-top: 1rem;
+  max-width: 98%;
+  overflow-x: auto;
 }
 
 .tab {
@@ -61,7 +63,6 @@ margin: 0;
   color: var(--sp-color);
   border-top-left-radius: 10px;
   border-top-right-radius: 10px;
-  margin-right: 4px;
   transition: background-color 0.2s ease;
 }
 
@@ -79,9 +80,9 @@ margin: 0;
   border-top: none;
   border-radius: 0 10px 10px 10px;
   color: var(--sp-color);
-  width: 100%;
   height: 100%;
   overflow-y: auto;
+  overflow-x: hidden;
 }
 
 .right-panel-content{

{deepboard-0.1.0 → deepboard-0.2.0}/deepboard/gui/assets/theme.css

@@ -66,6 +66,15 @@
     --chart-disabled-color: #555;
     --chart-typebox-shadow: 0 0 6px rgba(30, 144, 255, 0.5);
 
+    /*Artefacts (i.e. images, plots, text, etx)*/
+    --artefacts-card-bg: #1a1a1a;
+    --artefacts-card-shadow: 0 0 6px 2px rgba(255, 255, 255, 0.05);
+    --artefacts-card-radius: 8px;
+    --artefacts-header-line: 2px solid #333;
+    --artefacts-image_size: 10em;
+    --artefacts-text-color: var(--secondary-text-color);
+    --artefacts-text-font: monospace;
+
     /*Compare page*/
     --cmp-card-bg: #2a2a2a;
     --cmp-card-shadow: 0 1px 7px 0.5px rgba(255, 255, 255, 0.2);

deepboard-0.2.0/deepboard/gui/components/__init__.py

@@ -0,0 +1,8 @@
+from .chart_type import ChartType
+from .legend import Legend
+from .smoother import Smoother
+from .log_selector import LogSelector
+from .modal import Modal
+from .split_selector import SplitSelector
+from .stat_line import StatLine
+from .artefact_group import ArtefactGroup

deepboard-0.2.0/deepboard/gui/components/artefact_group.py

@@ -0,0 +1,12 @@
+from fasthtml.common import *
+
+def ArtefactGroup(*artefacts):
+    """
+    Create a group of images in a flex container that adapts to the number of images.
+    :param images: List of PIL Image objects.
+    :return: Div containing the images.
+    """
+    return Div(
+        *artefacts,
+        cls="artefact-group-container",
+    )

deepboard-0.2.0/deepboard/gui/components/log_selector.py

@@ -0,0 +1,22 @@
+from fasthtml.common import *
+
+def LogSelector(session, path: str, selected_rows_key: str, session_path: str):
+    if selected_rows_key in session and "selected-rows" in session[selected_rows_key] and len(session[selected_rows_key]["selected-rows"]) > 0:
+        runIDs = session[selected_rows_key]["selected-rows"]
+        runIDs = ','.join([str(i) for i in runIDs])
+    else:
+        print("Warning: no selected lines")
+        runIDs = ""
+        print(session)
+
+    if "chart_scale" not in session[session_path]:
+        session[session_path]["chart_scale"] = "default"
+    type = session[session_path]["chart_scale"]
+    return Div(
+        H2("Log Scale", cls="setup-title"),
+        Input(type="checkbox", name="log scale", id=f"chart-scale-{runIDs}", value="scale", cls="chart-type-checkbox",
+              checked=type == "log", hx_get=f"{path}/change_scale?runIDs={runIDs}&log={type == 'log'}",
+              hx_swap="outerHTML", hx_target="#chart-scale-selector"),
+        style="display: flex; flex-direction: row; align-items: center; justify-content: space-between; width: 100%;",
+        id="chart-scale-selector"
+    )

deepboard-0.2.0/deepboard/gui/components/modal.py

@@ -0,0 +1,20 @@
+from fasthtml.common import *
+
+
+def Modal(*content, active: bool = False):
+    return Div(
+        Button(
+            I(cls="fas fa-times"),
+            hx_get="/close_modal",
+            hx_target="#modal",
+            hx_swap="outerHTML",
+            cls="close-button",
+        ) if active else None,
+        Div(
+            *content,
+            cls="modal",
+            onclick="event.stopPropagation();",
+        ),
+        cls="modal-overlay" if active else "modal-overlay hidden",
+        id="modal"
+    )

deepboard-0.2.0/deepboard/gui/components/split_selector.py

@@ -0,0 +1,21 @@
+from fasthtml.common import *
+from typing import Literal
+
+def SplitSelector(runID, available_splits: List[str], selected: str, step: int, epoch: int, run_rep: int,
+                  type: str, path: str, swap: bool = False):
+
+    swap_oob = dict(swap_oob="true") if swap else {}
+    return Select(
+        *[
+            Option(split.capitalize() if split else "", value=split, selected=selected == split, cls="artefact-split-option")
+            for split in available_splits
+        ],
+        name="split_select",
+        hx_get=f"{path}?runID={runID}&step={step}&epoch={epoch}&run_rep={run_rep}&type={type}",
+        hx_target=f"#artefact-card-{step}-{epoch}-{run_rep}",
+        hx_trigger="change",
+        hx_swap="outerHTML",
+        hx_params="*",
+        **swap_oob,
+        cls="artefact-split-select",
+    )

deepboard-0.2.0/deepboard/gui/components/stat_line.py

@@ -0,0 +1,8 @@
+from fasthtml.common import *
+
+def StatLine(label: str, value: str):
+    return Span(
+        H3(f"{label}: ", style="font-size: 1em; margin: 0.1em; margin-right: 0.5em; font-weight: bold;"),
+        H3(value, style="font-size: 1em; margin: 0.1em; font-weight: normal;"),
+        cls="expand"
+    )

{deepboard-0.1.0 → deepboard-0.2.0}/deepboard/gui/entry.py

@@ -4,6 +4,13 @@ import sys
 
 
 def main():
+    try:
+        import fasthtml  # or whatever dependency is required
+    except ImportError:
+        raise ImportError(
+            "The GUI feature requires additional dependencies. Please install with:\n"
+            "  pip install deepboard[full]"
+        )
     if os.path.dirname(__file__) not in sys.path:
         sys.path.insert(0, os.path.dirname(__file__))
     script_path = os.path.join(os.path.dirname(__file__), "main.py")

{deepboard-0.1.0 → deepboard-0.2.0}/deepboard/gui/main.py

@@ -4,9 +4,10 @@ sys.path.append(os.getcwd())
 from fasthtml.common import *
 from deepboard.gui.pages.main_page.datagrid import SortableColumnsJs, right_click_handler_row, right_click_handler
 from deepboard.gui.pages.main_page import MainPage, build_main_page_endpoints
-from deepboard.gui.utils import prepare_db, Config, initiate_files, get_table_path_from_cli
+from deepboard.gui.utils import prepare_db, Config, initiate_files, get_table_path_from_cli, verify_runids
 from deepboard.gui.pages.compare_page import build_compare_routes, ComparePage
 from deepboard.gui.pages import _not_found
+from deepboard.gui.components import Modal
 from deepboard.resultTable import ResultTable
 from fh_plotly import plotly_headers
 
@@ -34,6 +35,7 @@ app = cls(
         Link(rel='stylesheet', href='assets/charts.css', type='text/css'),
         Link(rel='stylesheet', href='assets/fileview.css', type='text/css'),
         Link(rel='stylesheet', href='assets/compare.css', type='text/css'),
+        Link(rel='stylesheet', href='assets/artefacts.css', type='text/css'),
         Link(href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.0/css/all.min.css", rel="stylesheet"),
         plotly_headers,
         Script(src="assets/base.js"),
@@ -45,7 +47,7 @@ app = cls(
 rt = app.route
 @rt("/assets/{fname:path}.{ext:static}")
 async def get(fname:str, ext:str):
-    if fname == "theme" and ext == "css":
+    if fname == "theme" and ext == "css" and not DEBUG:
         if os.path.exists(os.path.expanduser('~/.config/deepboard/theme.css')):
             return FileResponse(os.path.expanduser('~/.config/deepboard/THEME.css'))
     root = os.path.dirname(os.path.abspath(__file__))
@@ -56,8 +58,13 @@ async def get(fname:str, ext:str):
 def get(session):
     if "show_hidden" not in session:
         session["show_hidden"] = False
+
+    # Check if row_selected exists.
+    verify_runids(session, rTable)
+
     return (Title("Table"),
             Div(id="custom-menu"),
+            Modal(P("Hellp world"), active=False),
             MainPage(session),
             )