Merge pull request #155 from artefactory/joss

ADD: JoSS submission Paper & Experiments
artefactory · Sep 6, 2024 · acd45e5 · acd45e5
2 parents 0a67406 + 2aeef3a
commit acd45e5
Show file tree

Hide file tree

Showing 17 changed files with 2,267 additions and 632 deletions.
diff --git a/.github/actions/build-draft.yaml b/.github/actions/build-draft.yaml
@@ -0,0 +1,23 @@
+name: Open Journals PDF Generator
+description: Create a draft PDF for an Open Journals paper
+inputs:
+  journal:
+    description: Target journal, must be either "joss" or "jose"
+    required: false
+    default: joss
+  paper-path:
+    description: >-
+        Path to the main paper Markdown file, relative to the
+        project's root directory.
+    required: false
+    default: 'paper.md'
+runs:
+  using: docker
+  image: 'docker://openjournals/inara:latest'
+  env:
+    GIT_SHA: $GITHUB_SHA
+    JOURNAL: ${{ inputs.journal }}
+  args:
+    - -o pdf
+    - -p
+    - ${{ inputs.paper-path }}
diff --git a/.github/actions/build-draft/action.yaml b/.github/actions/build-draft/action.yaml
@@ -0,0 +1,23 @@
+name: Open Journals PDF Generator
+description: Create a draft PDF for an Open Journals paper
+inputs:
+  journal:
+    description: Target journal, must be either "joss" or "jose"
+    required: false
+    default: joss
+  paper-path:
+    description: >-
+        Path to the main paper Markdown file, relative to the
+        project's root directory.
+    required: false
+    default: 'paper.md'
+runs:
+  using: docker
+  image: 'docker://openjournals/inara:latest'
+  env:
+    GIT_SHA: $GITHUB_SHA
+    JOURNAL: ${{ inputs.journal }}
+  args:
+    - -o pdf
+    - -p
+    - ${{ inputs.paper-path }}
diff --git a/.github/workflows/draft_paper.yml b/.github/workflows/draft_paper.yml
@@ -0,0 +1,29 @@
+name: Paper draft to PDF
+
+on:
+  push:
+    branches: 
+      - paper
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build draft PDF
+        uses: ./.github/actions/build-draft
+        with:
+          journal: joss
+          paper-path: docs/paper/paper.md
+
+      - name: Upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: paper
+          # This is the output path where Pandoc will write the compiled
+          # PDF. Note, this should be the same directory as the input
+          # paper.md
+          path: docs/paper/paper.pdf
diff --git a/choice_learn/datasets/expedia.py b/choice_learn/datasets/expedia.py
@@ -46,6 +46,7 @@ def load_expedia(as_frame=False, preprocessing="rumnet"):
                 get_path("preprocessed_expedia_rumnet.csv", module=CACHE_MODULE), engine="pyarrow"
             )
             logging.info("Loaded cached preprocessed data.")
+
         except FileNotFoundError:
             expedia_df.date_time = pd.to_datetime(expedia_df.date_time, format="%Y-%m-%d %H:%M:%S")
             expedia_df.loc[:, "day_of_week"] = expedia_df.loc[:, "date_time"].dt.dayofweek

diff --git a/docs/illustrations/features_storage.png b/docs/illustrations/features_storage.png
diff --git a/docs/illustrations/features_storage_2.png b/docs/illustrations/features_storage_2.png
diff --git a/docs/illustrations/features_storage_3.png b/docs/illustrations/features_storage_3.png
diff --git a/docs/illustrations/full_ram.png b/docs/illustrations/full_ram.png
diff --git a/docs/illustrations/items_vs_shared_features.png b/docs/illustrations/items_vs_shared_features.png
diff --git a/docs/illustrations/ram_usage_comparison.png b/docs/illustrations/ram_usage_comparison.png
diff --git a/docs/illustrations/table.png b/docs/illustrations/table.png