From c750cfd5ca98556503d86a65fea659343190e012 Mon Sep 17 00:00:00 2001 From: Hadrien Mary Date: Sat, 25 Nov 2023 09:05:41 -0500 Subject: [PATCH] few tweaks --- docs/api/plot.md | 2 +- docs/api/simpd.md | 11 +++++++++++ docs/api/split.md | 2 -- docs/api/splito.md | 3 +++ docs/api/utils.md | 6 +----- mkdocs.yml | 23 ++++++++++++----------- 6 files changed, 28 insertions(+), 19 deletions(-) create mode 100644 docs/api/simpd.md delete mode 100644 docs/api/split.md create mode 100644 docs/api/splito.md diff --git a/docs/api/plot.md b/docs/api/plot.md index 3e7d28b..94d77d8 100644 --- a/docs/api/plot.md +++ b/docs/api/plot.md @@ -1,3 +1,3 @@ # `splito.plot` -::: splito.plot.plot_distance_distributions \ No newline at end of file +::: splito.plot diff --git a/docs/api/simpd.md b/docs/api/simpd.md new file mode 100644 index 0000000..15d50ee --- /dev/null +++ b/docs/api/simpd.md @@ -0,0 +1,11 @@ +# `splito.simpd` + +::: splito.simpd.SIMPDSplitter + +--- + +::: splito.simpd.run_SIMPD + +--- + +::: splito.simpd.DEFAULT_SIMPD_DESCRIPTORS diff --git a/docs/api/split.md b/docs/api/split.md deleted file mode 100644 index c52fa2f..0000000 --- a/docs/api/split.md +++ /dev/null @@ -1,2 +0,0 @@ -# `split` -::: splito diff --git a/docs/api/splito.md b/docs/api/splito.md new file mode 100644 index 0000000..d6dd703 --- /dev/null +++ b/docs/api/splito.md @@ -0,0 +1,3 @@ +# `splito` + +::: splito diff --git a/docs/api/utils.md b/docs/api/utils.md index 66c62bd..d829959 100644 --- a/docs/api/utils.md +++ b/docs/api/utils.md @@ -1,7 +1,3 @@ # `splito.utils` -::: splito.utils.EmpiricalKernelMapTransformer -___ -::: splito.utils.get_iqr_outlier_bounds -___ -::: splito.utils.get_kmeans_clusters \ No newline at end of file +::: splito.utils diff --git a/mkdocs.yml b/mkdocs.yml index 13c1ff1..9af94b6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,15 +15,16 @@ strict: true nav: - Getting started: index.md - Tutorials: - - The Basics: tutorials/The_Basics.ipynb - - Structure-based Splitters: tutorials/Structure_based_Splitters.ipynb - - MOOD Protocol: tutorials/MOOD_Protocol.ipynb - - MPO Splitters: tutorials/MPO_Splitters.ipynb - - Other Splitters: tutorials/Other_Splitters.ipynb + - The Basics: tutorials/The_Basics.ipynb + - Structure-based Splitters: tutorials/Structure_based_Splitters.ipynb + - MOOD Protocol: tutorials/MOOD_Protocol.ipynb + - MPO Splitters: tutorials/MPO_Splitters.ipynb + - Other Splitters: tutorials/Other_Splitters.ipynb - API: - - splito.plot: api/plot.md - - splito.utils: api/utils.md - - split: api/split.md + - splito: api/splito.md + - splito.utils: api/utils.md + - splito.simpd: api/simpd.md + - splito.plot: api/plot.md theme: name: material @@ -66,8 +67,8 @@ markdown_extensions: - pymdownx.tabbed: alternate_style: true - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg - pymdownx.highlight: anchor_linenums: true line_spans: __span @@ -95,6 +96,7 @@ plugins: separate_signature: true show_signature_annotations: true line_length: 80 + - mkdocs-jupyter: execute: False @@ -105,4 +107,3 @@ extra: version: # Multi versioning provider for mkdocs-material (used for the JS selector) provider: mike -