From 0045fd563d464fd880d7c47c3e25e252e82c4377 Mon Sep 17 00:00:00 2001 From: Jan Meyer Date: Mon, 26 Aug 2024 15:55:25 +0200 Subject: [PATCH 1/4] adapt file structure to show extra type submodule --- .../community-notebooks/adventure_works.ipynb | 9 +++++++++ src/docs/reference/data/index.md | 10 ---------- src/docs/reference/data/roles.md | 10 ---------- src/docs/reference/data/time_series.md | 2 +- src/docs/reference/data/types.md | 3 +++ .../reference/datasets/{datasets.md => index.md} | 5 ----- src/docs/reference/datasets/types.md | 3 +++ .../reference/feature_learning/aggregations.md | 14 ++++++++++++++ .../feature_learning/aggregations/index.md | 1 - .../feature_learning/aggregations/sets.md | 7 ------- .../feature_learning/aggregations/types.md | 3 --- src/docs/reference/feature_learning/types.md | 3 +++ src/mkdocs.yml | 11 ++++++----- 13 files changed, 39 insertions(+), 42 deletions(-) create mode 100644 src/docs/reference/data/types.md rename src/docs/reference/datasets/{datasets.md => index.md} (83%) create mode 100644 src/docs/reference/datasets/types.md create mode 100644 src/docs/reference/feature_learning/aggregations.md delete mode 100644 src/docs/reference/feature_learning/aggregations/index.md delete mode 100644 src/docs/reference/feature_learning/aggregations/sets.md delete mode 100644 src/docs/reference/feature_learning/aggregations/types.md create mode 100644 src/docs/reference/feature_learning/types.md diff --git a/src/docs/examples/community-notebooks/adventure_works.ipynb b/src/docs/examples/community-notebooks/adventure_works.ipynb index 034e441e..b75eaab2 100644 --- a/src/docs/examples/community-notebooks/adventure_works.ipynb +++ b/src/docs/examples/community-notebooks/adventure_works.ipynb @@ -4,6 +4,15 @@ "cell_type": "markdown", "metadata": {}, "source": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", "# AdventureWorks - Predicting customer churn\n", "\n", "In this notebook, we will demonstrate how getML can be used for a customer churn project using a synthetic dataset of a fictional company.\n", diff --git a/src/docs/reference/data/index.md b/src/docs/reference/data/index.md index ccb9188e..620681cb 100644 --- a/src/docs/reference/data/index.md +++ b/src/docs/reference/data/index.md @@ -32,13 +32,3 @@ title: Data options: heading_level: 2 show_root_full_path: false - -::: getml.data.OnType - options: - heading_level: 2 - show_root_full_path: false - -::: getml.data.TimeStampsType - options: - heading_level: 2 - show_root_full_path: false \ No newline at end of file diff --git a/src/docs/reference/data/roles.md b/src/docs/reference/data/roles.md index 0b34afc9..3d92576a 100644 --- a/src/docs/reference/data/roles.md +++ b/src/docs/reference/data/roles.md @@ -5,16 +5,6 @@ show_submodules: false show_symbol_type_heading: false - -::: getml.data.roles.types - options: - heading_level: 2 - show_root_full_path: false - show_root_heading: true - show_root_toc_entry: true - show_if_no_docstring: true - - ::: getml.data.roles.sets options: heading_level: 2 diff --git a/src/docs/reference/data/time_series.md b/src/docs/reference/data/time_series.md index d47d1c86..7596e32d 100644 --- a/src/docs/reference/data/time_series.md +++ b/src/docs/reference/data/time_series.md @@ -3,4 +3,4 @@ show_root_toc_entry: false show_root_heading: true show_labels: true - show_if_no_docstring: true + show_if_no_docstring: false diff --git a/src/docs/reference/data/types.md b/src/docs/reference/data/types.md new file mode 100644 index 00000000..a20f4323 --- /dev/null +++ b/src/docs/reference/data/types.md @@ -0,0 +1,3 @@ +::: getml.data.types + options: + show_if_no_docstring: true \ No newline at end of file diff --git a/src/docs/reference/datasets/datasets.md b/src/docs/reference/datasets/index.md similarity index 83% rename from src/docs/reference/datasets/datasets.md rename to src/docs/reference/datasets/index.md index c83cbcc4..56670e68 100644 --- a/src/docs/reference/datasets/datasets.md +++ b/src/docs/reference/datasets/index.md @@ -20,8 +20,3 @@ title: Datasets - make_same_units_categorical - make_same_units_numerical - make_snowflake - -::: getml.datasets.base.DataFrameT - options: - heading_level: 2 - show_root_full_path: false \ No newline at end of file diff --git a/src/docs/reference/datasets/types.md b/src/docs/reference/datasets/types.md new file mode 100644 index 00000000..96453ebe --- /dev/null +++ b/src/docs/reference/datasets/types.md @@ -0,0 +1,3 @@ +::: getml.datasets.types + options: + show_if_no_docstring: true \ No newline at end of file diff --git a/src/docs/reference/feature_learning/aggregations.md b/src/docs/reference/feature_learning/aggregations.md new file mode 100644 index 00000000..233686c5 --- /dev/null +++ b/src/docs/reference/feature_learning/aggregations.md @@ -0,0 +1,14 @@ +::: getml.feature_learning.aggregations + options: + show_root_toc_entry: true + show_root_heading: true + show_submodules: false + show_symbol_type_heading: false + + +::: getml.feature_learning.aggregations.sets + options: + heading_level: 2 + show_root_full_path: false + show_root_heading: true + show_root_toc_entry: true diff --git a/src/docs/reference/feature_learning/aggregations/index.md b/src/docs/reference/feature_learning/aggregations/index.md deleted file mode 100644 index bd3a6ec2..00000000 --- a/src/docs/reference/feature_learning/aggregations/index.md +++ /dev/null @@ -1 +0,0 @@ -::: getml.feature_learning.aggregations diff --git a/src/docs/reference/feature_learning/aggregations/sets.md b/src/docs/reference/feature_learning/aggregations/sets.md deleted file mode 100644 index a5017906..00000000 --- a/src/docs/reference/feature_learning/aggregations/sets.md +++ /dev/null @@ -1,7 +0,0 @@ -::: getml.feature_learning.aggregations.sets - options: - members: - - AggregationsSets - - FastPropAggregationsSets - - MultirelAggregationsSets - - MappingAggregationsSets \ No newline at end of file diff --git a/src/docs/reference/feature_learning/aggregations/types.md b/src/docs/reference/feature_learning/aggregations/types.md deleted file mode 100644 index 09345c9c..00000000 --- a/src/docs/reference/feature_learning/aggregations/types.md +++ /dev/null @@ -1,3 +0,0 @@ -::: getml.feature_learning.aggregations.types - options: - show_if_no_docstring: true \ No newline at end of file diff --git a/src/docs/reference/feature_learning/types.md b/src/docs/reference/feature_learning/types.md new file mode 100644 index 00000000..e4edffaf --- /dev/null +++ b/src/docs/reference/feature_learning/types.md @@ -0,0 +1,3 @@ +::: getml.feature_learning.types + options: + show_if_no_docstring: true \ No newline at end of file diff --git a/src/mkdocs.yml b/src/mkdocs.yml index 1f163869..e0b50320 100644 --- a/src/mkdocs.yml +++ b/src/mkdocs.yml @@ -317,8 +317,11 @@ nav: - split: reference/data/split.md - time: reference/data/time.md - subroles: reference/data/subroles.md + - types: reference/data/types.md - getml.database: reference/database/database.md - - getml.datasets: reference/datasets/datasets.md + - getml.datasets: + - reference/datasets/index.md + - types: reference/datasets/types.md - getml.engine: reference/engine/engine.md - getml.hyperopt: - reference/hyperopt/index.md @@ -332,11 +335,9 @@ nav: - Multirel: reference/feature_learning/multirel.md - Relboost: reference/feature_learning/relboost.md - RelMT: reference/feature_learning/relmt.md - - aggregations: - - reference/feature_learning/aggregations/index.md - - types: reference/feature_learning/aggregations/types.md - - sets: reference/feature_learning/aggregations/sets.md - loss_functions: reference/feature_learning/loss_functions.md + - aggregations: reference/feature_learning/aggregations.md + - types: reference/feature_learning/types.md - getml.project: - reference/project/index.md - DataFrames: reference/project/data_frames.md From 8d2907dfce87d55b71279f1959a080d4df8eb9b1 Mon Sep 17 00:00:00 2001 From: Jan Meyer Date: Wed, 28 Aug 2024 11:15:30 +0200 Subject: [PATCH 2/4] add pipeline and hyperopt pages --- src/docs/reference/hyperopt/types.md | 3 +++ src/docs/reference/pipeline/types.md | 3 +++ src/mkdocs.yml | 2 ++ 3 files changed, 8 insertions(+) create mode 100644 src/docs/reference/hyperopt/types.md create mode 100644 src/docs/reference/pipeline/types.md diff --git a/src/docs/reference/hyperopt/types.md b/src/docs/reference/hyperopt/types.md new file mode 100644 index 00000000..afdd8879 --- /dev/null +++ b/src/docs/reference/hyperopt/types.md @@ -0,0 +1,3 @@ +::: getml.hyperopt.types + options: + show_if_no_docstring: true \ No newline at end of file diff --git a/src/docs/reference/pipeline/types.md b/src/docs/reference/pipeline/types.md new file mode 100644 index 00000000..a7921b75 --- /dev/null +++ b/src/docs/reference/pipeline/types.md @@ -0,0 +1,3 @@ +::: getml.pipeline.types + options: + show_if_no_docstring: true \ No newline at end of file diff --git a/src/mkdocs.yml b/src/mkdocs.yml index e0b50320..ffc0fff5 100644 --- a/src/mkdocs.yml +++ b/src/mkdocs.yml @@ -328,6 +328,7 @@ nav: - Gaussian Process: reference/hyperopt/gaussian.md - Latin Hypercube: reference/hyperopt/latin.md - Random: reference/hyperopt/random.md + - types: reference/hyperopt/types.md - getml.feature_learning: - reference/feature_learning/index.md - FastProp: reference/feature_learning/fastprop.md @@ -362,6 +363,7 @@ nav: # - metadata: reference/pipeline/metadata.md - metrics: reference/pipeline/metrics.md - dialect: reference/pipeline/dialect.md + - types: reference/pipeline/types.md - getml.predictors: - reference/predictors/index.md - LinearRegression: reference/predictors/linear_regression.md From fa28509b7c4d2defe3cdd5f5b400951b77b2bac1 Mon Sep 17 00:00:00 2001 From: Jan Meyer Date: Wed, 28 Aug 2024 18:21:21 +0200 Subject: [PATCH 3/4] remove spurious empty lines --- .../examples/community-notebooks/adventure_works.ipynb | 9 --------- 1 file changed, 9 deletions(-) diff --git a/src/docs/examples/community-notebooks/adventure_works.ipynb b/src/docs/examples/community-notebooks/adventure_works.ipynb index b75eaab2..034e441e 100644 --- a/src/docs/examples/community-notebooks/adventure_works.ipynb +++ b/src/docs/examples/community-notebooks/adventure_works.ipynb @@ -4,15 +4,6 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "\n", - "\n", - "\n", - "\n", - "\n", - "\n", - "\n", - "\n", - "\n", "# AdventureWorks - Predicting customer churn\n", "\n", "In this notebook, we will demonstrate how getML can be used for a customer churn project using a synthetic dataset of a fictional company.\n", From 76e71bef0fd967fa81d601b00a5edd1444aac533 Mon Sep 17 00:00:00 2001 From: Jan Meyer Date: Wed, 28 Aug 2024 18:24:19 +0200 Subject: [PATCH 4/4] remove redundant option --- src/docs/reference/data/time_series.md | 1 - 1 file changed, 1 deletion(-) diff --git a/src/docs/reference/data/time_series.md b/src/docs/reference/data/time_series.md index 7596e32d..997efb61 100644 --- a/src/docs/reference/data/time_series.md +++ b/src/docs/reference/data/time_series.md @@ -3,4 +3,3 @@ show_root_toc_entry: false show_root_heading: true show_labels: true - show_if_no_docstring: false