TinyExp 0.0.1__tar.gz

tinyexp-0.0.1/.gitignore

@@ -0,0 +1,151 @@
+docs/source
+
+# From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
+
+# 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
+
+# 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/
+
+# Vscode config files
+.vscode/
+
+# 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/
+
+# logs, data and outputs
+data
+data/
+output
+output/
+output*/
+**/output/
+**/output*/
+wandb/
+**/wandb/

tinyexp-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,126 @@
+# Contributing to `TinyExp`
+
+Contributions are welcome, and they are greatly appreciated!
+Every little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+# Types of Contributions
+
+## Report Bugs
+
+Report bugs at https://github.com/zengarden/TinyExp/issues
+
+If you are reporting a bug, please include:
+
+- Your operating system name and version.
+- Any details about your local setup that might be helpful in troubleshooting.
+- Detailed steps to reproduce the bug.
+
+## Fix Bugs
+
+Look through the GitHub issues for bugs.
+Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.
+
+## Implement Features
+
+Look through the GitHub issues for features.
+Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
+
+## Write Documentation
+
+TinyExp could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
+
+## Submit Feedback
+
+The best way to send feedback is to file an issue at https://github.com/zengarden/TinyExp/issues.
+
+If you are proposing a new feature:
+
+- Explain in detail how it would work.
+- Keep the scope as narrow as possible, to make it easier to implement.
+- Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+# Get Started!
+
+Ready to contribute? Here's how to set up `TinyExp` for local development.
+Please note this documentation assumes you already have `uv` and `Git` installed and ready to go.
+
+1. Fork the `TinyExp` repo on GitHub.
+
+2. Clone your fork locally:
+
+```bash
+cd <directory_in_which_repo_should_be_created>
+git clone git@github.com:YOUR_NAME/TinyExp.git
+```
+
+3. Now we need to install the environment. Navigate into the directory
+
+```bash
+cd TinyExp
+```
+
+Then, install and activate the environment with:
+
+```bash
+uv sync
+```
+
+4. Install pre-commit to run linters/formatters at commit time:
+
+```bash
+uv run pre-commit install
+```
+
+5. Create a branch for local development:
+
+```bash
+git checkout -b name-of-your-bugfix-or-feature
+```
+
+Now you can make your changes locally.
+
+6. Don't forget to add test cases for your added functionality to the `tests` directory.
+
+7. When you're done making changes, check that your changes pass the formatting tests.
+
+```bash
+make check
+```
+
+Now, validate that all unit tests are passing:
+
+```bash
+make test
+```
+
+9. Before raising a pull request you should also run tox.
+   This will run the tests across different versions of Python:
+
+```bash
+tox
+```
+
+This requires you to have multiple versions of python installed.
+This step is also triggered in the CI/CD pipeline, so you could also choose to skip this step locally.
+
+10. Commit your changes and push your branch to GitHub:
+
+```bash
+git add .
+git commit -m "Your detailed description of your changes."
+git push origin name-of-your-bugfix-or-feature
+```
+
+11. Submit a pull request through the GitHub website.
+
+# Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+
+2. If the pull request adds functionality, the docs should be updated.
+   Put your new functionality into a function with a docstring, and add the feature to the list in `README.md`.

tinyexp-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Zeming LI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tinyexp-0.0.1/Makefile

@@ -0,0 +1,53 @@
+.PHONY: install
+install: ## Install the virtual environment and install the pre-commit hooks
+	@echo "🚀 Creating virtual environment using uv"
+	@uv sync
+	@uv run pre-commit install
+
+.PHONY: check
+check: ## Run code quality tools.
+	@echo "🚀 Checking lock file consistency with 'pyproject.toml'"
+	@uv lock --locked
+	@echo "🚀 Linting code: Running pre-commit"
+	@uv run pre-commit run -a
+	# @echo "🚀 Static type checking: Running mypy"
+	# @uv run mypy
+
+.PHONY: test
+test: ## Test the code with pytest
+	@echo "🚀 Testing code: Running pytest"
+	@uv run python -m pytest --cov --cov-config=pyproject.toml --cov-report=xml
+
+.PHONY: build
+build: clean-build ## Build wheel file
+	@echo "🚀 Creating wheel file"
+	@uvx --from build pyproject-build --installer uv
+
+.PHONY: clean-build
+clean-build: ## Clean build artifacts
+	@echo "🚀 Removing build artifacts"
+	@uv run python -c "import shutil; import os; shutil.rmtree('dist') if os.path.exists('dist') else None"
+
+.PHONY: publish
+publish: ## Publish a release to PyPI.
+	@echo "🚀 Publishing."
+	@uvx twine upload --repository testpypi dist/*
+	# @uvx twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
+
+.PHONY: build-and-publish
+build-and-publish: build publish ## Build and publish.
+
+.PHONY: docs-test
+docs-test: ## Test if documentation can be built without warnings or errors
+	@uv run mkdocs build -s
+
+.PHONY: docs
+docs: ## Build and serve the documentation
+	@uv run mkdocs serve
+
+.PHONY: help
+help:
+	@uv run python -c "import re; \
+	[[print(f'\033[36m{m[0]:<20}\033[0m {m[1]}') for m in re.findall(r'^([a-zA-Z_-]+):.*?## (.*)$$', open(makefile).read(), re.M)] for makefile in ('$(MAKEFILE_LIST)').strip().split()]"
+
+.DEFAULT_GOAL := help

tinyexp-0.0.1/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: TinyExp
+Version: 0.0.1
+Summary: A minimalist Python project for deep learning experiment management. It uses Ray for core distributed environment and backend setup, and provides basic, no-frills tracking for models, optimizers, and LR schedulers.
+Project-URL: Homepage, https://zengarden.github.io/TinyExp/
+Project-URL: Repository, https://github.com/zengarden/TinyExp
+Project-URL: Documentation, https://zengarden.github.io/TinyExp/
+Author-email: Zeming LI <zane.li@connect.ust.hk>
+License: MIT License
+        
+        Copyright (c) 2025 Zeming LI
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: python
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <4.0,>=3.9
+Requires-Dist: accelerate
+Requires-Dist: hydra-core
+Requires-Dist: loguru
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: numpy
+Requires-Dist: omegaconf
+Requires-Dist: ray
+Requires-Dist: redis
+Requires-Dist: tabulate
+Requires-Dist: torch
+Requires-Dist: torchvision
+Requires-Dist: tqdm
+Requires-Dist: wandb
+Description-Content-Type: text/markdown
+
+[![Main](https://github.com/HKUST-SAIL/tinyexp/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/HKUST-SAIL/tinyexp/actions/workflows/main.yml)
+[![codecov](https://codecov.io/gh/HKUST-SAIL/TinyExp/branch/main/graph/badge.svg)](https://codecov.io/gh/HKUST-SAIL/TinyExp)
+
+# TinyExp
+
+A simple Python project for deep learning experiment management.
+
+TinyExp lets you launch experiments with one click: the file you edit becomes the entrypoint to your experiment.
+
+# Usage
+
+```
+pip install tinyexp
+```
+
+1. Run mnist example(By default, It will trained on CPU)
+
+```python
+import tinyexp
+from tinyexp.examples.mnist_exp import Exp, store_and_run_exp
+store_and_run_exp(Exp)
+```
+
+2. or:
+
+```
+python tinyexp/examples/mnist_exp.py
+```
+
+3. Run mnist example with overridden config:
+
+```
+python tinyexp/examples/mnist_exp.py dataloader_cfg.train_batch_size_per_device=16
+```
+
+see all available configs:
+
+```
+python tinyexp/examples/mnist_exp.py mode=help
+```
+
+see all available configs with overridden configs:
+
+```
+python tinyexp/examples/mnist_exp.py mode=help dataloader_cfg.train_batch_size_per_device=16
+```
+
+
+# More Examples
+
+1. ImageNet ResNet-50 Example with Extremely Fast Data Loading (By default, all available GPUs will be used.)
+
+```python
+# export IMAGENET_HOME=yours_imagenet_dir
+
+import tinyexp
+from tinyexp.examples.resnet_exp import ResNetExp, store_and_run_exp
+store_and_run_exp(ResNetExp)
+```
+
+# Develop
+
+1. prepare env
+
+```bash
+# 1. clone repo
+git clone https://github.com/HKUST-SAIL/tinyexp.git
+# 2. Set Up Your Development Environment, This will also generate your `uv.lock` file
+make install
+source .venv/bin/activate
+```
+
+2. After development, checking whether the code is standardized
+
+```bash
+# Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
+uv run pre-commit run -a
+```
+
+# License
+
+MIT License. See `LICENSE`.

tinyexp-0.0.1/README.md

@@ -0,0 +1,82 @@
+[![Main](https://github.com/HKUST-SAIL/tinyexp/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/HKUST-SAIL/tinyexp/actions/workflows/main.yml)
+[![codecov](https://codecov.io/gh/HKUST-SAIL/TinyExp/branch/main/graph/badge.svg)](https://codecov.io/gh/HKUST-SAIL/TinyExp)
+
+# TinyExp
+
+A simple Python project for deep learning experiment management.
+
+TinyExp lets you launch experiments with one click: the file you edit becomes the entrypoint to your experiment.
+
+# Usage
+
+```
+pip install tinyexp
+```
+
+1. Run mnist example(By default, It will trained on CPU)
+
+```python
+import tinyexp
+from tinyexp.examples.mnist_exp import Exp, store_and_run_exp
+store_and_run_exp(Exp)
+```
+
+2. or:
+
+```
+python tinyexp/examples/mnist_exp.py
+```
+
+3. Run mnist example with overridden config:
+
+```
+python tinyexp/examples/mnist_exp.py dataloader_cfg.train_batch_size_per_device=16
+```
+
+see all available configs:
+
+```
+python tinyexp/examples/mnist_exp.py mode=help
+```
+
+see all available configs with overridden configs:
+
+```
+python tinyexp/examples/mnist_exp.py mode=help dataloader_cfg.train_batch_size_per_device=16
+```
+
+
+# More Examples
+
+1. ImageNet ResNet-50 Example with Extremely Fast Data Loading (By default, all available GPUs will be used.)
+
+```python
+# export IMAGENET_HOME=yours_imagenet_dir
+
+import tinyexp
+from tinyexp.examples.resnet_exp import ResNetExp, store_and_run_exp
+store_and_run_exp(ResNetExp)
+```
+
+# Develop
+
+1. prepare env
+
+```bash
+# 1. clone repo
+git clone https://github.com/HKUST-SAIL/tinyexp.git
+# 2. Set Up Your Development Environment, This will also generate your `uv.lock` file
+make install
+source .venv/bin/activate
+```
+
+2. After development, checking whether the code is standardized
+
+```bash
+# Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
+uv run pre-commit run -a
+```
+
+# License
+
+MIT License. See `LICENSE`.