https://github.com/sinzlab/neuralpredictors
Machine Learning Utils of Sinzlab
https://github.com/sinzlab/neuralpredictors
Last synced: 5 months ago
JSON representation
Machine Learning Utils of Sinzlab
- Host: GitHub
- URL: https://github.com/sinzlab/neuralpredictors
- Owner: sinzlab
- License: mit
- Created: 2019-01-09T12:14:18.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-02-27T10:51:41.000Z (over 1 year ago)
- Last Synced: 2025-09-24T03:33:25.145Z (9 months ago)
- Language: Jupyter Notebook
- Size: 2.39 MB
- Stars: 29
- Watchers: 8
- Forks: 48
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Neuralpredictors
[](https://github.com/sinzlab/neuralpredictors/actions/workflows/test.yml)
[](https://codecov.io/gh/sinzlab/neuralpredictors)
[](https://github.com/sinzlab/neuralpredictors/actions/workflows/black.yml)
[](https://github.com/sinzlab/neuralpredictors/actions/workflows/mypy.yml)
[](https://github.com/sinzlab/neuralpredictors/actions/workflows/isort.yml)
[](https://badge.fury.io/py/neuralpredictors)
[](https://zenodo.org/badge/latestdoi/164856779)
[Sinz Lab](https://sinzlab.org/) Neural System Identification Utilities for [PyTorch](https://pytorch.org/).
## How to run the tests :test_tube:
Clone this repository and run the following command from within the cloned repository to run all tests:
```bash
docker-compose run pytest
```
## How to contribute :fire:
Pull requests (and issues) are always welcome. This section describes some
preconditions that pull requests need to fulfill.
### Tests
Please make sure your changes pass the tests. Take a look at the [test running
section](#how-to-run-the-tests-test_tube) for instructions on how to run them. Adding tests
for new code is not mandatory but encouraged.
### Code Style
#### black
This project uses the [black](https://github.com/psf/black) code formatter. You
can check whether your changes comply with its style by running the following
command:
```bash
docker-compose run black
```
Furthermore you can pass a path to the service to have black fix any errors in
the Python modules it finds in the given path.
#### isort
[isort](https://github.com/PyCQA/isort) is used to sort Python imports. You can check the order of imports by running the following command:
```bash
docker-compose run isort
```
The imports can be sorted by passing a path to the service.
### Type Hints
We use [mypy](https://github.com/python/mypy) as a static type checker. Running
the following command will check the code for any type errors:
```bash
docker-compose run mypy
```
It is not necessary (but encouraged) to add type hints to new code but please
make sure your changes do not produce any mypy errors.
Note that only modules specified in the `mypy-files.txt` file are checked by
mypy. This is done to be able to add type hints gradually without drowning in
errors. If you want to add type annotations to a previously unchecked module
you have to add its path to `mypy-files.txt`.