add installation and contribution guidelines - Githubissues

sandylaker / saliency-metrics

An Open-source Framework for Benchmarking Explanation Methods in Computer Vision

https://saliency-metrics.readthedocs.io

MIT License

1 stars 3 forks source link

add installation and contribution guidelines #10

Closed sandylaker closed 2 years ago

sandylaker commented 2 years ago

Short Description

Add installation and contribution guidelines.

Long Description

Please write a long description about this pull request.

Checklist

[x] Code linting are passed. (Please run pre-commit run --all-files).
[x] Mypy checks are passed. (Please run mypy saliency_metrics).
[x] Unit tests are added for new code.
[x] Documentation is added for the new code.
[x] Unit tests are passed. (Please run sh tests/run_tests.sh).
[x] Docs are successfully built. (Please run cd docs/ && make html and host the webpage locally).