Skip to content

Commit 35d2826

Browse files
committed
update README
1 parent b364799 commit 35d2826

1 file changed

Lines changed: 11 additions & 20 deletions

File tree

README.md

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The package allows to reproduce the evaluation results, as well as to apply Tran
2424

2525
## Content
2626

27-
This replication package belongs to "Recovering Trace Links Between Software Documentation And Code" by :warning: *TODO* authors + link to paper.
27+
This replication package belongs to [Recovering Trace Links Between Software Documentation And Code](https://publikationen.bibliothek.kit.edu/1000165692) by Keim et al. (DOI: 10.5445/IR/1000165692).
2828

2929
This replication package allows to:
3030
* get additional details to the publication (pseudocode for the computation of trace links between SAM and Code)
@@ -59,7 +59,7 @@ This documentation is structured as follows:
5959

6060
## How TransArC Works
6161

62-
TransArC is an approach described in "Recovering Trace Links Between Software Documentation And Code" by :warning: *TODO* authors + link to paper.
62+
TransArC is an approach described in [Recovering Trace Links Between Software Documentation And Code](https://publikationen.bibliothek.kit.edu/1000165692) by Keim et al. (DOI: 10.5445/IR/1000165692).
6363
TransArC combines two approaches: ArDoCo for linking architecture documentation to models and ArCoTL for linking architecture models to code.
6464
Thereby, TransArC bridges the gap between architecture documentation and code.
6565

@@ -133,7 +133,11 @@ _BYKdQDVgEeqPG_FgW3bi6Q,Interface: RecommenderStrategy,services/tools.descartes.
133133
## Reproduction of Complete Evaluation Results
134134

135135
Please be aware that the reproduction of the complete evaluation results can take some time due to the calculation of the baselines.
136-
:warning: **TODO** Describe our system + needed time.
136+
On our system (Tesla V100S, 32GB VRAM, 256GB RAM, 112 CPUs á 2.7Ghz), the execution takes approximately:
137+
* CodeBERT: 4h
138+
* FTLR: 20 min
139+
* TAROT: 10 min
140+
* TransArC: 7 min
137141
Everything was tested on Linux.
138142

139143
### Hardware Requirements
@@ -162,8 +166,7 @@ Requirements:
162166
* Python 3.9 (for FTLR)
163167
* Python 3.7 (for CodeBERT)
164168
* Git + LFS Support
165-
166-
Install the dependencies in: :warning: **TODO**
169+
* Internet (for CodeBERT)
167170

168171
##### CodeBERT
169172

@@ -179,19 +182,9 @@ Download our new CodeBERT model for Java: https://huggingface.co/kit-mcse/CodeBE
179182

180183
Copy and unzip the downloaded model folder to `../models/codeBert`
181184

182-
Execute CodeBERT:
183-
```
184-
cd trace/trace_single
185-
python eval_trace_single_SAD.py \
186-
--data_dir ../../data/<ProjectName> \
187-
--model_path ../../../models/codeBert \
188-
--per_gpu_eval_batch_size 10 \
189-
--exp_name "<ProjectName>_single"
190-
```
191-
192-
The output is written to: :warning: **TODO**
185+
Execute CodeBERT: `bash execute_baseline_codebert.sh`
193186

194-
It should look like:
187+
The output should look like:
195188

196189
```
197190
INFO:__main__:model loaded
@@ -252,7 +245,7 @@ ENGLISH_FASTTEXT_MODEL_PATH = "/replication/baselines/models/cc.en.300.bin"
252245
ITALIAN_FASTTEXT_MODEL_PATH = "/replication/baselines/models/cc.it.300.bin"
253246
```
254247

255-
To run FTLR execute: `python3.9 App.py`
248+
To run FTLR execute: `bash execute_baseline_ftlr.sh`
256249

257250
Please be aware that the output of FTLR is very verbose.
258251
Warnings like `ERROR:preprocessing.JavaLangUtil:Unknown case: [MemberReference(member=sessionBean, ...` can be ignored.
@@ -269,8 +262,6 @@ drwxr-xr-x 1 root root 4096 Dec 19 13:18 ../
269262
-rw-r--r-- 1 root root 44932 Dec 19 13:15 MediaStore_FileLevelWMDMc_tracelinks.csv
270263
```
271264

272-
App.py aufsplitten? :warning: **TODO**
273-
274265

275266
##### TAROT
276267

0 commit comments

Comments
 (0)