diff --git a/assets/img/Traceability_screenshot.png b/assets/img/Traceability_screenshot.png new file mode 100644 index 0000000..42eed25 Binary files /dev/null and b/assets/img/Traceability_screenshot.png differ diff --git a/docs/supplements/ArtifactTemplate.md b/docs/supplements/ArtifactTemplate.md new file mode 100644 index 0000000..36ae75e --- /dev/null +++ b/docs/supplements/ArtifactTemplate.md @@ -0,0 +1,151 @@ +# Artifact README Template + +> Artifact for paper: **** + +_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 + + +[Download the preprint from ArXiv/DOI/etc.](https://arxiv.org/abs/xxxx.xxxxx) + + +[Access the anonymized preprint](./docs/preprint.pdf) + + + +## 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 + + + +1. Using virtual environment: +```bash +# Create and activate environment +conda create -n python=3.8 +conda activate +# Install dependencies +pip install -r requirements.txt +``` + +2. Using Docker: + +```bash +docker build -t . +docker run -it -v $(pwd):/app -w /app 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). **. *Conference/Journal Name*. + +**BibTeX:** + +```bibtex +@inproceedings{yourkey, + title={Your Paper Title}, + author={Author, A. and Author, B.}, + booktitle={Conference/Journal}, + year={Year}, + ... +} +``` + +## License + + + +## Contact + +For questions or issues, please contact: + +* **Lead Author:** [Name](mailto:author@example.com) +* **Repository Issues:** `https://github.com/yourorg/yourartifact/issues` diff --git a/tab_04_supplements.md b/tab_04_supplements.md index 4af62b2..62d29f9 100644 --- a/tab_04_supplements.md +++ b/tab_04_supplements.md @@ -79,6 +79,7 @@ function openSupplementFromURL(evt) {
  • Other