Skip to content

Commit 73636e7

Browse files
committed
📝 docs(README): update README
1 parent b2edd73 commit 73636e7

File tree

5 files changed

+5
-66
lines changed

5 files changed

+5
-66
lines changed

.project-root

Lines changed: 0 additions & 2 deletions
This file was deleted.

.vscode/launch.json

Lines changed: 0 additions & 21 deletions
This file was deleted.

.vscode/settings.json

Lines changed: 0 additions & 27 deletions
This file was deleted.

README.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ _Don't hesitate to open a new issue if you encounter problems while using this m
2020

2121
- [Introduction](#introduction)
2222
- [Installation](#installation)
23-
- [Package requirements](#package-requirements)
2423
- [Project structure](#project-structure)
2524
- [Tutorials](#tutorials)
2625
- [Citation](#citation)
@@ -33,25 +32,15 @@ The adoption of Deep Neural Networks (DNNs) in critical fields where predictions
3332

3433
## Installation
3534

36-
If you already have [PyTorch](https://pytorch.org/) installed on your machine,
37-
the latest version of P-TAME can be obtained from [PyPI](https://pypi.org/project/ptame/) as follows:
35+
The latest version of P-TAME can be obtained from [PyPI](https://pypi.org/project/ptame/) as follows:
3836

3937
```bash
4038
pip install ptame
4139
```
4240

43-
### Package requirements
44-
45-
The package requirements are as follows:
46-
47-
```text
48-
python>=3.10.0
49-
torch>=2.0.0
50-
```
51-
5241
## Project structure
5342

54-
The directory structure of new project looks like this:
43+
The directory structure of the project is explained below:
5544

5645
```tree
5746
├── data <- Project data
@@ -88,11 +77,11 @@ The directory structure of new project looks like this:
8877

8978
## Tutorials
9079

91-
To learn how to reproduce the results in tables 1 and 2 of the [paper](https://arxiv.org/abs/2501.17813), and how to apply the method to classifiers besides the ones included in the experiments, refer to this page in the [documentation](<>).
80+
To learn how to reproduce the results in tables 1 and 2 of the [paper](https://arxiv.org/abs/2501.17813), and how to apply the method to classifiers besides the ones included in the experiments, refer to the[documentation](https://idt-iti.github.io/P-TAME/).
9281

9382
## Citation
9483

95-
If you fine this XAI explainability method interesting or useful in your research, use the following Bibtex annotation to cite us:
84+
If you find this XAI explainability method interesting or useful in your research, use the following Bibtex annotation to cite us:
9685

9786
```bibtex
9887
@misc{ntrougkas2025ptameexplainimageclassifier,

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)