From 9fbbb79a3982379ee849dc498cc1b43f31a238af Mon Sep 17 00:00:00 2001 From: VincentAuriau Date: Mon, 8 Jan 2024 17:01:30 +0100 Subject: [PATCH 1/3] DOC: Reorg --- .../data/references_choice_dataset.md} | 0 docs/references/data/references_dataset.md | 3 +++ docs/references/data/references_store.md | 3 +++ .../models}/references_base_model.md | 2 +- docs/{ => references/models}/references_clogit.md | 2 +- docs/{ => references/models}/references_rumnet.md | 2 +- mkdocs.yaml | 13 +++++++++---- 7 files changed, 18 insertions(+), 7 deletions(-) rename docs/{references_data.md => references/data/references_choice_dataset.md} (100%) create mode 100644 docs/references/data/references_dataset.md create mode 100644 docs/references/data/references_store.md rename docs/{ => references/models}/references_base_model.md (64%) rename docs/{ => references/models}/references_clogit.md (62%) rename docs/{ => references/models}/references_rumnet.md (65%) diff --git a/docs/references_data.md b/docs/references/data/references_choice_dataset.md similarity index 100% rename from docs/references_data.md rename to docs/references/data/references_choice_dataset.md diff --git a/docs/references/data/references_dataset.md b/docs/references/data/references_dataset.md new file mode 100644 index 00000000..48164b63 --- /dev/null +++ b/docs/references/data/references_dataset.md @@ -0,0 +1,3 @@ +# OpenSource datasets Loaders + +:::choice_learn.datasets.base diff --git a/docs/references/data/references_store.md b/docs/references/data/references_store.md new file mode 100644 index 00000000..26e4e5f1 --- /dev/null +++ b/docs/references/data/references_store.md @@ -0,0 +1,3 @@ +# Features Storage + +:::choice_learn.data.store diff --git a/docs/references_base_model.md b/docs/references/models/references_base_model.md similarity index 64% rename from docs/references_base_model.md rename to docs/references/models/references_base_model.md index 7eafcdf5..cda16f5c 100644 --- a/docs/references_base_model.md +++ b/docs/references/models/references_base_model.md @@ -1,3 +1,3 @@ -# ChoiceDataset +# Base model class :::choice_learn.models.base_model diff --git a/docs/references_clogit.md b/docs/references/models/references_clogit.md similarity index 62% rename from docs/references_clogit.md rename to docs/references/models/references_clogit.md index 4551842f..bfd508c5 100644 --- a/docs/references_clogit.md +++ b/docs/references/models/references_clogit.md @@ -1,3 +1,3 @@ -# ChoiceDataset +# Conditional MNL class :::choice_learn.models.conditional_mnl diff --git a/docs/references_rumnet.md b/docs/references/models/references_rumnet.md similarity index 65% rename from docs/references_rumnet.md rename to docs/references/models/references_rumnet.md index 19e0ecec..507e9070 100644 --- a/docs/references_rumnet.md +++ b/docs/references/models/references_rumnet.md @@ -1,3 +1,3 @@ -# ChoiceDataset +# RUMnet class :::choice_learn.models.rumnet diff --git a/mkdocs.yaml b/mkdocs.yaml index 001f9652..b596078d 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -54,10 +54,15 @@ nav: - How-To Guides: - Introduction: how-to-guides.md - ChoiceDataset Usage: notebooks/choice_learn_introduction_data.md + - Conditional Logit Estimation: notebooks/choice_learn_introduction_clogit.md + - Custom Choice Model Creation: notebooks/choice_learn_introduction_data.md - References: - - references_data.md + - Data: + - ChoiceDataset: references/data/references_choice_dataset.md + - Features Storage: references/data/references_store.md + - Available Datasets: references/data/references_dataset.md - Choice Models: - - Base Model: references_base_model.md - - Conditional Logit: references_clogit.md - - RUMnet: references_rumnet.md + - Base Model: references/models/references_base_model.md + - Conditional Logit: references/models/references_clogit.md + - RUMnet: references/models/references_rumnet.md - explanations.md From 3f4c3677d9aed83568bff4efe00ba604ce18e36c Mon Sep 17 00:00:00 2001 From: VincentAuriau Date: Mon, 8 Jan 2024 17:03:39 +0100 Subject: [PATCH 2/3] fix branch mkdocs on push --- .github/workflows/deploy_docs.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml index a1663645..1d40dc21 100644 --- a/.github/workflows/deploy_docs.yaml +++ b/.github/workflows/deploy_docs.yaml @@ -2,7 +2,8 @@ name: Deploy MkDocs to GitHub Pages on: push: - branch: [main] + branches: + - main jobs: deploy-docs: From db3c8da0749ede6f9eddeaf9db6b79bac83fd5b5 Mon Sep 17 00:00:00 2001 From: VincentAuriau Date: Mon, 8 Jan 2024 17:05:07 +0100 Subject: [PATCH 3/3] ADD: ci mkdocs on PR --- .github/workflows/deploy_docs.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml index 1d40dc21..22500072 100644 --- a/.github/workflows/deploy_docs.yaml +++ b/.github/workflows/deploy_docs.yaml @@ -4,6 +4,9 @@ on: push: branches: - main + pull_request: + branches: + - main jobs: deploy-docs: