Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added assets/img/Traceability_screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
151 changes: 151 additions & 0 deletions docs/supplements/ArtifactTemplate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
# Artifact README Template

> Artifact for paper: **<Paper Title>**

_NOTE for authors: The [Open Science](./docs/supplements/OpenScience.md) page in the Empirical Standard provides additional information on criteria and examples of good artifacts. Please take a moment to review it._


## Preprint

<!--
For single-blind review (reviewers know author identities):
Provide a direct link to the online preprint
-->
[Download the preprint from ArXiv/DOI/etc.](https://arxiv.org/abs/xxxx.xxxxx)

<!--
For double-blind review (reviewers don't know author identities):
Include the PDF directly in the artifact and reference it locally
Do NOT include any identifying information or links that would reveal author identities
-->
[Access the anonymized preprint](./docs/preprint.pdf)

<!-- Choose ONE of the above options based on your venue's review model and DELETE the other -->

## Table of Contents

1. [Overview](#overview)
2. [Claim-to-Artifact Traceability](#claim-to-artifact-traceability)
3. [Repository Structure](#repository-structure)
4. [Getting Started](#getting-started)
5. [Usage](#usage)
6. [Artifact Contents](#artifact-contents)
7. [Citations](#citations)
8. [License](#license)
9. [Contact](#contact)

## Overview

Briefly describe the artifact, its purpose, and how it supports the claims or contributions of the paper.

## Claim-to-Artifact Traceability

This table maps key paper sections or claims to corresponding artifact components. It ensures reproducibility and transparency.

| Paper Section / Claim | Artifact Component | Location |
| ------------------------------------- | ------------------------- | -------------------------- |
| Claim 1 (e.g., RQ1: data stats) | Data preprocessing script | `scripts/preprocess.py` |
| Claim 2 (e.g., RQ2: model evaluation) | Evaluation notebook | `notebooks/evaluate.ipynb` |
| Claim 3 (e.g., RQ3: visualization) | Plotting utility | `scripts/plot_results.py` |
| ... | ... | ... |

Here is a screenshot illustrating this mapping, taken from [ICSE'23 Paper: An Empirical Study of Pre-Trained Model Reuse in the Hugging Face Deep Learning Model Registry](https://github.com/PurdueDualityLab/ICSE-23-PTM-Artifact)

![Traceability Screenshot](./assets/img/Traceability_screenshot.png)

## Repository Structure

Describe the top-level and important subdirectories:

```plaintext
.
├── scripts/ # Python scripts for data processing and analysis
├── data/ # Raw and processed datasets
│ ├── raw/
│ └── processed/
├── notebooks/ # Jupyter notebooks for exploration and evaluation
├── results/ # Generated figures and tables
├── docs/ # Documentation and supplementary materials
└── README.md # This file
```

## Getting Started

### Prerequisites

* Python 3.x (e.g., 3.8 or higher)
* Conda or virtualenv
* Docker (optional, for containerized runs)

### Installation

<!-- If installation is required, please provide a Dockerfile or a script to install the dependencies. -->

1. Using virtual environment:
```bash
# Create and activate environment
conda create -n <env_name> python=3.8
conda activate <env_name>
# Install dependencies
pip install -r requirements.txt
```

2. Using Docker:

```bash
docker build -t <image_name> .
docker run -it -v $(pwd):/app -w /app <image_name> bash
```

## Usage

### 1. Data Preparation

```bash
python scripts/preprocess.py \
--input data/raw \
--output data/processed
```

### 2. Analysis

```bash
python scripts/analyze.py \
--data data/processed \
--output results/figures
```

### 3. Reproduce Notebooks & Figures

```bash
python scripts/generate_figures.py
```

## To cite this work

**APA Citation:**

> Author, A., & Author, B. (Year). *<Paper Title>*. *Conference/Journal Name*.

**BibTeX:**

```bibtex
@inproceedings{yourkey,
title={Your Paper Title},
author={Author, A. and Author, B.},
booktitle={Conference/Journal},
year={Year},
...
}
```

## License

<!-- Specify the license under which the artifact is released (e.g., MIT, Apache 2.0). -->

## Contact

For questions or issues, please contact:

* **Lead Author:** [Name](mailto:[email protected])
* **Repository Issues:** `https://github.com/yourorg/yourartifact/issues`
8 changes: 8 additions & 0 deletions tab_04_supplements.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ function openSupplementFromURL(evt) {
<li>
<h3>Other</h3>
<ul>
<li><a id="ArtifactTemplate_b" class="tablinks" href="#" onclick="openSupplement(event, 'ArtifactTemplate')">Artifact Template</a></li>
<li><a id="InformationVisualization_b" class="tablinks" href="#" onclick="openSupplement(event, 'InformationVisualization')">Information Visualization</a></li>
<li><a id="InterRaterReliabilityAndAgreement_b" class="tablinks" href="#" onclick="openSupplement(event, 'InterRaterReliabilityAndAgreement')">Inter-Rater Reliability and Agreement</a></li>
<li><a id="OpenScience_b" class="tablinks" href="#" onclick="openSupplement(event, 'OpenScience')">Open Science</a></li>
Expand Down Expand Up @@ -112,6 +113,13 @@ function openSupplementFromURL(evt) {
</p>
</div>

<div id="ArtifactTemplate" class="tabcontent">
<p>
{% capture std %}{% include_relative docs/supplements/ArtifactTemplate.md %}{% endcapture %}
{{ std | replace: '- [ ]', '-' | markdownify }}
</p>
</div>

<div id="InformationVisualization" class="tabcontent">
<p>
{% capture std %}{% include_relative docs/supplements/InformationVisualization.md %}{% endcapture %}
Expand Down