Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
egpbos authored Oct 19, 2023
1 parent 4dc9818 commit 03d0c54
Showing 1 changed file with 1 addition and 26 deletions.
27 changes: 1 addition & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,7 @@
## Badges

(Customize these badges with your own links, and check https://shields.io/ or https://badgen.net/ to see which other badges are available.)

| fair-software.eu recommendations | |
| :-- | :-- |
| (1/5) code repository | [![github repo badge](https://img.shields.io/badge/github-repo-000.svg?logo=github&labelColor=gray&color=blue)]([email protected]:dianna-ai/distance_explainer) |
| (2/5) license | [![github license badge](https://img.shields.io/github/license/dianna-ai/distance_explainer)]([email protected]:dianna-ai/distance_explainer) |
| (3/5) community registry | [![RSD](https://img.shields.io/badge/rsd-distance_explainer-00a3e3.svg)](https://www.research-software.nl/software/distance_explainer) [![workflow pypi badge](https://img.shields.io/pypi/v/distance_explainer.svg?colorB=blue)](https://pypi.python.org/project/distance_explainer/) |
| (4/5) citation | [![DOI](https://zenodo.org/badge/DOI/<replace-with-created-DOI>.svg)](https://doi.org/<replace-with-created-DOI>) |
| (5/5) checklist | [![workflow cii badge](https://bestpractices.coreinfrastructure.org/projects/<replace-with-created-project-identifier>/badge)](https://bestpractices.coreinfrastructure.org/projects/<replace-with-created-project-identifier>) |
| howfairis | [![fair-software badge](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow)](https://fair-software.eu) |
| **Other best practices** | &nbsp; |
| Documentation | [![Documentation Status](https://readthedocs.org/projects/distance_explainer/badge/?version=latest)](https://distance_explainer.readthedocs.io/en/latest/?badge=latest) |
| **GitHub Actions** | &nbsp; |
| Build | [![build]([email protected]:dianna-ai/distance_explainer/actions/workflows/build.yml/badge.svg)]([email protected]:dianna-ai/distance_explainer/actions/workflows/build.yml) |
| Citation data consistency | [![cffconvert]([email protected]:dianna-ai/distance_explainer/actions/workflows/cffconvert.yml/badge.svg)]([email protected]:dianna-ai/distance_explainer/actions/workflows/cffconvert.yml) |
| MarkDown link checker | [![markdown-link-check]([email protected]:dianna-ai/distance_explainer/actions/workflows/markdown-link-check.yml/badge.svg)]([email protected]:dianna-ai/distance_explainer/actions/workflows/markdown-link-check.yml) |

## How to use distance_explainer
# `distance_explainer`

XAI method to explain distances in embedded spaces

The project setup is documented in [project_setup.md](project_setup.md). Feel free to remove this document (and/or the link to this document) if you don't need it.

## Installation

To install distance_explainer from GitHub repository, do:
Expand All @@ -33,10 +12,6 @@ cd distance_explainer
python3 -m pip install .
```

## Documentation

Include a link to your project's full documentation here.

## Contributing

If you want to contribute to the development of distance_explainer,
Expand Down

0 comments on commit 03d0c54

Please sign in to comment.