Fix A100/H100 profiles, add examples + GitHub Pages docs, exclude toy_models from distribution, prep for PyPI#6
Open
vh2001 wants to merge 6 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hardware profile fixes: corrected
nvidia_a100_80gb's FP16 throughput (312 → 77.97 TFLOPS) and TDP (300 → 400 W), andnvidia_h100_sxm's FP16 throughput (990 → 267.7 TFLOPS), insrc/ecal/hardware/data/profiles.yaml. Updated the matching tables inREADME.mdanddocs/configuration.mdto match.Examples: added
examples/basic_estimate.py(minimal single-callecal.estimate()usage) andexamples/full_pipeline.py(the same computation walked through stage-by-stage via the low-levelTransmission/DataPreprocessing/Training/Inferenceclasses, useful as a reference for anyone needing finer control thanestimate()exposes).GitHub Pages deployment for docs: added
.github/workflows/docs.yml— builds the Sphinx docs with-W --keep-going(warnings fail the build) on every push/PR, and deploys to GitHub Pages on pushes tomainor manual dispatch.Excluded
ecal.calculators.toy_modelsfrom the installable package: it's experimental scratch code (untested, not exported, and depends onefficient_kan, which isn't a declared dependency). Its content now lives only in the legacycalculators/ToyModels.py, alongsidescripts//notebooks/, rather than shipping inside theecalpackage.PyPI publishing prep:
setuptools-scmbuild dependency — it wasn't driving versioning (version is static) but its presence made setuptools default to bundling the entire repo into the sdist (legacy dirs, notebooks, docs source, CI config, etc.).MANIFEST.inso the sdist explicitly includes the fulltests/directory (conftest.py/__init__.pywere otherwise silently dropped).Documentationproject URL; updatedHomepagetohttps://github.com/sensorlab/eCAL.