Python package for evaluating neuron segmentations in terms of the number of splits and merges
Project description
aind-segmentation-evaluation
Python package for performing a skeleton-based evaluation of a predicted segmentation of neuron axons. Given a predicted segmentation (i.e. pred_volume) and ground truth skeleton (i.e. target_graph), the evaluation is performed by detecting splits and merges in the prediction, then several statistics are computed from these quantities.
Installation
To use the software, in the root directory, run
pip install -e .
To develop the code, run
pip install -e .[dev]
To install this package from PyPI, run
pip install aind-segmentation-evaluation
Contributing
Linters and testing
There are several libraries used to run linters, check documentation, and run tests.
- Please test your changes using the coverage library, which will run the tests and log a coverage report:
coverage run -m unittest discover && coverage report
- Use interrogate to check that modules, methods, etc. have been documented thoroughly:
interrogate .
- Use flake8 to check that code is up to standards (no unused imports, etc.):
flake8 .
- Use black to automatically format the code into PEP standards:
black .
- Use isort to automatically sort import statements:
isort .
Pull requests
For internal members, please create a branch. For external members, please fork the repository and open a pull request from the fork. We'll primarily use Angular style for commit messages. Roughly, they should follow the pattern:
<type>(<scope>): <short summary>
where scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:
- build: Changes that affect build tools or external dependencies (example scopes: pyproject.toml, setup.py)
- ci: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)
- docs: Documentation only changes
- feat: A new feature
- fix: A bugfix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- test: Adding missing tests or correcting existing tests
Documentation
To generate the rst files source files for documentation, run
sphinx-apidoc -o doc_template/source/ src
Then to create the documentation HTML files, run
sphinx-build -b html doc_template/source/ doc_template/build/html
More info on sphinx installation can be found here.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aind_segmentation_evaluation-0.0.24.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45cb1cee321cf0bc4526eadefe6d1047fa960cf99b3c0260dbc1f775cf8be0a8 |
|
MD5 | 8b7ce43ae05128fa36099c2b2742430e |
|
BLAKE2b-256 | 6dbefc50341c85c69ca3bbad7c94ada5eba11792cd5378628c6b9bd24bc96409 |
Hashes for aind_segmentation_evaluation-0.0.24-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97a8c4f70b22041b74e3290228c4d01babcba346541196d1bb72ea2042f562ff |
|
MD5 | 0fa976abd7ea8c76415fe1c7df2915a1 |
|
BLAKE2b-256 | 701915d9f46b0d9acfa831dfba67db8227f42eaa660c0cb4789fc8fdef67aeca |