File size: 2,526 Bytes
1b50562 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | site_name: Aspara User Manual
site_description: Aspara, blazingly fast metrics tracker for machine learning experiments
site_author: Aspara Development Group
copyright: Copyright © 2026 Aspara Development Group
use_directory_urls: false
theme:
name: material
language: en
logo: aspara-icon.png
favicon: aspara-icon.png
palette:
primary: indigo
accent: indigo
features:
- navigation.tabs
- navigation.sections
- navigation.top
- search.highlight
- content.code.copy
extra_css:
- aspara-theme.css
plugins:
- search
- mkdocstrings:
handlers:
python:
paths:
- src
selection:
docstring_style: google
rendering:
show_source: true
show_if_no_docstring: false
show_root_heading: false
show_root_toc_entry: false
heading_level: 2
show_signature_annotations: true
separate_signature: true
merge_init_into_class: false
docstring_section_style: "spacy"
show_symbol_type_heading: true
show_symbol_type_toc: true
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.superfences
- pymdownx.inlinehilite
- admonition
- pymdownx.details
- pymdownx.tabbed:
alternate_style: true
- tables
- footnotes
nav:
- Home: index.md
- Getting Started:
- Overview: getting-started.md
- User Guide:
- Overview: user-guide/basics.md
- Core Concepts: user-guide/concepts.md
- Metadata and Notes: user-guide/metadata.md
- Visualizing Results in Dashboard: user-guide/dashboard-visualization.md
- Terminal UI: user-guide/terminal-ui.md
- Best Practices: user-guide/best-practices.md
- Troubleshooting: user-guide/troubleshooting.md
- Advanced:
- Configuration: advanced/configuration.md
- LocalRun vs RemoteRun: advanced/local-vs-remote.md
- Storage: advanced/storage.md
- Dashboard: advanced/dashboard.md
- Tracker API: advanced/tracker-api.md
- Read-only Mode: advanced/read-only-mode.md
- Examples:
- Overview: examples/index.md
- PyTorch: examples/pytorch_example.md
- TensorFlow / Keras: examples/tensorflow_example.md
- scikit-learn: examples/sklearn_example.md
- API Reference:
- Overview: api/index.md
- aspara: api/aspara.md
- Run: api/run.md
- Dashboard API: api/dashboard.md
- Tracker API: api/tracker.md
- Contributing: contributing.md
|