Skip to content

Commit

Permalink
Merge pull request #1 from tillahoffmann/action
Browse files Browse the repository at this point in the history
Add GitHub Action to test reproduction materials.
  • Loading branch information
tillahoffmann authored Sep 13, 2023
2 parents 06cfadc + d1d5d96 commit 300c384
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 2 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/main.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Reproduction Materials

on:
push:
branches: ["main"]
pull_request:
branches: ["main"]
workflow_dispatch:

jobs:
build:
name: Build
runs-on: "ubuntu-latest"
steps:
- uses: "actions/checkout@v3"
- name: Build Docker image.
run: docker build -t gptools .
- name: Generate figures (using ./in-docker.sh but we can't use `-it` in the Action).
run: docker run --rm -e FAST=true -v `pwd`:/workdir gptools cook exec figures
- name: Upload figures and reports as artifacts.
uses: actions/upload-artifact@v3
with:
name: figures-reports
path: |
*/*.html
*/*.pdf
*/*.png
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Reproduction materials for "Scalable Gaussian Process Inference with Stan"
# Reproduction materials for "Scalable Gaussian Process Inference with Stan" [![Reproduction Materials](https://github.com/tillahoffmann/gptools-reproduction-material/actions/workflows/main.yaml/badge.svg)](https://github.com/tillahoffmann/gptools-reproduction-material/actions/workflows/main.yaml)

This repository comprises code and data to reproduce the results and figures in the accompanying manuscript [Scalable Gaussian Process Inference with Stan](https://doi.org/10.48550/arXiv.2301.08836).

Expand Down Expand Up @@ -27,9 +27,13 @@ For any of the subsequent commands, they can be executed by either running `[the

If you switch between containerized and local runtime, you may need to remove compiled Stan programs because binaries are not interoperable. Run `[./in-docker.sh] cook exec rm-compiled` to do so.

### Continuous integration

To ensure the reproducibility of these materials, the results are also computed as the output of a GitHub Action workflow [![Reproduction Materials](https://github.com/tillahoffmann/gptools-reproduction-material/actions/workflows/main.yaml/badge.svg)](https://github.com/tillahoffmann/gptools-reproduction-material/actions/workflows/main.yaml) with the `FAST=true` flag. Figures can be obtained by selecting a workflow run and downloading the `figures-reports` artifact.

## Running the experiments

Figures in the manuscript were generated using the containerized runtime, and all runtime estimates below are based on a 2020 Macbook Pro with M1 chip and 16 GB of memory running macOS 13.4 (22F66). All figures can be reproduced by running `[./in-docker.sh] cook exec figures` (see below for details).
Figures in the manuscript were generated using the containerized runtime, and all runtime estimates below are based on a 2020 Macbook Pro with M1 chip and 16 GB of memory running macOS 13.4 (22F66). Figures are generated by executing Jupyter notebooks stored in markdown format. All figures can be reproduced by running `[./in-docker.sh] cook exec figures` (see below for details).

### Applications

Expand Down

0 comments on commit 300c384

Please sign in to comment.