danielz02 commited on
Commit
cab4654
1 Parent(s): 0733bef

Add instructions for installation and change log

Browse files
Files changed (1) hide show
  1. src/display/about.py +70 -1
src/display/about.py CHANGED
@@ -65,7 +65,76 @@ Examples of these vulnerabilities are shown below.
65
  We normalize the score of each perspective as 0-100, and these scores are the higher the better.
66
 
67
  ## Reproducibility
68
- To reproduce our results, checkout https://github.com/AI-secure/DecodingTrust
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
69
 
70
  """
71
 
 
65
  We normalize the score of each perspective as 0-100, and these scores are the higher the better.
66
 
67
  ## Reproducibility
68
+ Please follow the following instructions to install DecodingTrust
69
+
70
+ ### (Conda +) Pip
71
+
72
+ For now, we suggest installing DecodingTrust by cloning our repository and install it in editable mode. This will keep the data, code, and configurations in the same place.
73
+
74
+ ```bash
75
+ git clone https://github.com/AI-secure/DecodingTrust.git && cd DecodingTrust
76
+ pip install -e .
77
+ ```
78
+
79
+ Please note that this will install PyTorch with `pip`. If your system does not have a `CUDA` version compatible with the PyTorch `pip` wheel. To install `PyTorch` with `Conda` first, as shown below.
80
+
81
+ ```bash
82
+ conda create --name dt-test python=3.9 pytorch torchvision torchaudio pytorch-cuda=12.1 -c pytorch -c nvidia
83
+ conda activate dt-test
84
+ pip install "decoding-trust @ git+https://github.com/AI-secure/DecodingTrust.git"
85
+ ```
86
+
87
+ It is also possible to install DecodingTrust as a standalone package, but you will need to clone our repository again to run it with our data.
88
+ ```bash
89
+ conda create --name dt-test python=3.9
90
+ conda activate dt-test
91
+ pip install "decoding-trust @ git+https://github.com/AI-secure/DecodingTrust.git"
92
+ ```
93
+
94
+ ### Support for the `ppc64le` Architecture
95
+
96
+ We also support the `ppc64le` architecture of IBM Power-9 platforms. To install on this platform, please first make
97
+ sure you have the following `conda` channels so that we can utilize pre-built packages.
98
+
99
+ ```
100
+ --add channels 'defaults' # lowest priority
101
+ --add channels 'https://public.dhe.ibm.com/ibmdl/export/pub/software/server/ibm-ai/conda-early-access/'
102
+ --add channels 'https://public.dhe.ibm.com/ibmdl/export/pub/software/server/ibm-ai/conda/'
103
+ --add channels 'https://opence.mit.edu'
104
+ --add channels 'https://ftp.osuosl.org/pub/open-ce/current/'
105
+ --add channels 'conda-forge' # highest priority
106
+ ```
107
+
108
+ Then, install the following pre-built packages.
109
+
110
+ ```bash
111
+ mamba create --name dt-test python==3.9 pytorch=2.0.1 torchvision=0.15.2 spacy=3.5.3 scipy=1.10.1
112
+ fairlearn~=0.9.0 scikit-learn~=1.1.2 pandas~=2.0.3 pyarrow~=11.0.0 rust -c conda-forge
113
+ ```
114
+
115
+ Finally, install DecodingTrust with `pip` as usual.
116
+
117
+ ### Docker / Singularity
118
+
119
+ To use DecodingTrust with docker, simply pull the following docker image.
120
+ ```bash
121
+ sudo docker pull danielz01/decoding-trust
122
+ docker run -it \
123
+ -v /path/on/host:/path/in/container \
124
+ --gpus all \
125
+ decoding-trust/v1.0:latest [arg1 arg2 ...]
126
+ ```
127
+ To use it in through singularity or apptainer container environments on HPC environments, simply run the following.
128
+ ```bash
129
+ module load singularity # Change it to whatever module name your singularity / apptainer environment was given
130
+ singularity pull decoding-trust-v1.0.sif docker://danielz01/decoding-trust
131
+ singularity exec --nv --bind /path/on/host:/path/in/container decoding-trust-v1.0.sif [arg1 arg2]
132
+ ```
133
+
134
+ To run our evaluations, checkout our [tutorial](https://github.com/AI-secure/DecodingTrust/blob/main/Tutorial.md).
135
+
136
+ ## Change Log
137
+ 01/17/24: Add the initial version of the leaderboard
138
 
139
  """
140