Contributing

Bug reports, feature requests, and pull requests are welcome.

Getting started

git clone https://github.com/sxa-lab/blackboxml.git
cd blackboxml
pip install -e .

For Keras callback development:

pip install -e ".[keras]"

Running tests

pytest

Building the package

python setup.py sdist bdist_wheel

Project structure

File	Role
__init__.py	Public exports
tracker.py	@track decorator and Run context manager
metrics.py	MetricStore batch-to-epoch aggregation
store.py	JSON persistence (save_run, load_run, list_runs, delete_all_runs)
callback.py	BlackBoxCallback for Keras
visualiser.py	visualise_run() plotting
cli.py	bbml CLI built with Click

Code style

• Follow PEP 8
• Use Python's logging module
• Type hints on all public APIs

Templates

• Bug reports
• Feature requests
• Security policy
• Code of conduct

License

Apache License 2.0, maintained by SxA Lab