Merge pull request #23 from HKA-IES/dev

First release

.gitignore

@@ -1,2 +1,7 @@
 .idea/
-**/__pycache__/
+**/__pycache__/
+*.egg-info
+build/
+remotetestbench.ini
+examples/epidenet_nas/cpu_modelstudy/
+examples/epidenet_nas/gpu_modelstudy/

LICENSE

@@ -1 +1,9 @@
-[...]
+MIT License
+
+Copyright (c) 2024 Laboratory for the Design of Microsystems, University of Freiburg, Germany.
+
+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.

README.md

@@ -1,3 +1,45 @@
-# BrainMEP NAS - PUBLIC
+# BrainMEP NAS - PUBLIC REPO
 
-[...]
+![Python](https://img.shields.io/badge/python-3.8|3.9|3.10|3.11|3.12|3.13-blue.svg)
+
+This repository contains the public code used for the NAS process for the
+Brain-MEP Project.
+
+## Requirements
+- Linux distribution
+  - If you are under Windows, consider using [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install) (WSL)
+- [task-spooler](https://github.com/justanhduc/task-spooler)
+- [SQLite 3](https://sqlite.org/)
+
+## Install it from the repository
+
+### Python >= 3.10
+```
+pip install git+https://github.com/HKA-IES/brainmep-nas
+```
+
+### Python >= 3.8, <3.10
+The timescoring package only officially supports Python >= 3.10. However, we 
+have found that timescoring 0.0.5 works fine with Python 3.8, 3.9 if dependency
+requirements are ignored. 
+```
+pip install timescoring --ignore-requires --no-dependencies
+pip install nptyping
+pip install git+https://github.com/HKA-IES/brainmep-nas
+```
+
+## Usage
+The package *brainmepnas* consists in utility modules to faciliate the 
+implementation of a NAS process for the Brain-MEP project. Example uses are
+shown in examples/.
+
+## Development
+Please note that the goal of this package is not to offer a general framework 
+for NAS. It was built around the needs of the Brain-MEP project and is designed
+for this specific use-case.
+
+Please do not hesitate to submit issues if you have found bugs or if the
+documentation is unclear.
+
+## License
+This project is licensed under the MIT License.

brainmepnas/__init__.py

@@ -0,0 +1,11 @@
+from .dataset import Dataset
+from .accuracymetrics import AccuracyMetrics
+from .hardwaremetrics import HardwareMetrics
+from .combinedmetrics import CombinedMetrics
+from .abstractmodelstudy import AbstractModelStudy
+
+# Note: mltkhardwaremetrics.MltkHardwareMetrics and
+# testbenchhardwaremetrics.TestbenchHardwareMetrics are not automatically
+# imported to 1) prevent issues with missing optional dependencies and 2)
+# prevent auto-importing big packages such as tensorflow when importing any
+# component of the brainmepnas package.