forked from acmsigsoft/EmpiricalStandards
-
Notifications
You must be signed in to change notification settings - Fork 0
Add Artifact Template #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Wenxin-Jiang
wants to merge
4
commits into
master
Choose a base branch
from
wenxin/template
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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) | ||
|
|
||
|  | ||
|
|
||
| ## 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` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.