From 3cf1e5457ee455054a5630b2cb8330e3c78dbd5d Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Fri, 2 Feb 2024 15:00:38 +0100 Subject: [PATCH 01/18] add features list to docs --- docs/conf.py | 4 +++- docs/features.rst | 56 +++++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 6 ++++- 3 files changed, 64 insertions(+), 2 deletions(-) create mode 100644 docs/features.rst diff --git a/docs/conf.py b/docs/conf.py index 5ccb066d..25d74926 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,7 +27,9 @@ 'sphinx.ext.viewcode', 'sphinx.ext.intersphinx', 'sphinx.ext.napoleon', - 'sphinx.ext.viewcode' + 'sphinx.ext.viewcode', + "sphinx_design", + "sphinx_design_elements", ] intersphinx_mapping = {'python': ('https://docs.python.org/3.10', None)} diff --git a/docs/features.rst b/docs/features.rst new file mode 100644 index 00000000..0195b760 --- /dev/null +++ b/docs/features.rst @@ -0,0 +1,56 @@ +.. _features: + +Overview of available features +============================== + +.. div:: dropdown-group + + .. dropdown:: Descriptor Sets + + :class:`~qsprpred.data.descriptors.sets.DescriptorSet`: Base class for descriptor sets. + Descriptor sets are used to calculate molecular descriptors for a set of molecules. + + .. tab-set:: + + .. tab-item:: Core + + * :class:`~qsprpred.data.descriptors.sets.DrugExPhyschem`: DrugExPhyschem + * :class:`~qsprpred.data.descriptors.sets.PredictorDesc`:PredictorDesc + * :class:`~qsprpred.data.descriptors.sets.RDKitDescs`: RDKitDescs + * :class:`~qsprpred.data.descriptors.sets.SmilesDescs`: SmilesDescs + * :class:`~qsprpred.data.descriptors.sets.TanimotoDistances`: TanimotoDistances + * :class:`~qsprpred.data.descriptors.sets.DataFrameDescriptorSet`: DataFrameDescriptorSet + * :class:`~qsprpred.data.descriptors.fingerprints.Fingerprint`: Fingerprint + * :class:`~qsprpred.data.descriptors.fingerprints.AtomPairFP`: AtomPairFP + * :class:`~qsprpred.data.descriptors.fingerprints.AvalonFP`: AvalonFP + * :class:`~qsprpred.data.descriptors.fingerprints.LayeredFP`: LayeredFP + * :class:`~qsprpred.data.descriptors.fingerprints.MACCsFP`: MACCsFP + * :class:`~qsprpred.data.descriptors.fingerprints.MorganFP`: MorganFP + * :class:`~qsprpred.data.descriptors.fingerprints.PatternFP`: PatternFP + * :class:`~qsprpred.data.descriptors.fingerprints.RDKitFP`: RDKitFP + * :class:`~qsprpred.data.descriptors.fingerprints.RDKitMACCSFP`: RDKitMACCSFP + * :class:`~qsprpred.data.descriptors.fingerprints.TopologicalFP`: TopologicalFP + + .. tab-item:: Extra + + * :class:`~qsprpred.extra.data.descriptors.sets.ExtendedValenceSignature`: ExtendedValenceSignature + * :class:`~qsprpred.extra.data.descriptors.sets.Mold2`: Mold2 + * :class:`~qsprpred.extra.data.descriptors.sets.Mordred`: Mordred + * :class:`~qsprpred.extra.data.descriptors.sets.PaDEL`: PaDEL + * :class:`~qsprpred.extra.data.descriptors.sets.ProteinDescriptorSet`: ProteinDescriptorSet + * :class:`~qsprpred.extra.data.descriptors.sets.ProDec`: ProDec + * :class:`~qsprpred.data.descriptors.fingerprints.Fingerprint`: Fingerprint + * :class:`~qsprpred.extra.data.descriptors.fingerprints.CDKAtomPairs2DFP`: CDKAtomPairs2DFP + * :class:`~qsprpred.extra.data.descriptors.fingerprints.CDKEStateFP`: CDKEStateFP + * :class:`~qsprpred.extra.data.descriptors.fingerprints.CDKExtendedFP`: CDKExtendedFP + * :class:`~qsprpred.extra.data.descriptors.fingerprints.CDKFP`: CDKFP + * :class:`~qsprpred.extra.data.descriptors.fingerprints.CDKGraphOnlyFP`: CDKGraphOnlyFP + * :class:`~qsprpred.extra.data.descriptors.fingerprints.CDKKlekotaRothFP`: CDKKlekotaRothFP + * :class:`~qsprpred.extra.data.descriptors.fingerprints.CDKMACCSFP`: CDKMACCSFP + * :class:`~qsprpred.extra.data.descriptors.fingerprints.CDKPubchemFP`: CDKPubchemFP + * :class:`~qsprpred.extra.data.descriptors.fingerprints.CDKSubstructureFP`: CDKSubstructureFP + + .. dropdown:: Dropdown B + + Dropdown content B + diff --git a/docs/index.rst b/docs/index.rst index a7c4ef7a..d0b03ab2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,7 +6,10 @@ Welcome to QSPRpred's documentation! ==================================== -QSPRpred provides functionality to assist with building Quantitative Structure Property relationship models. Model built with QSPRpred can also be used as the enviroment reward function in DrugEx. Here you will find the installation guide (:ref:`installation`), usage examples (:ref:`usage`) and API documentation. +QSPRpred provides functionality to assist with building Quantitative Structure Property relationship models. +Models built with QSPRpred can also be used as the enviroment reward function in DrugEx. +Here you will find the installation guide (:ref:`installation`), an overview of available features (:ref:`features`), usage examples (:ref:`usage`) and API documentation (:ref:`api/modules:Python API`). + .. toctree:: :maxdepth: 2 @@ -15,6 +18,7 @@ QSPRpred provides functionality to assist with building Quantitative Structure P self install use + features api/modules From 27604b06e7c697549ec50556dbad550be02aad06 Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Fri, 2 Feb 2024 15:06:00 +0100 Subject: [PATCH 02/18] add all categories --- docs/features.rst | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/docs/features.rst b/docs/features.rst index 0195b760..dbaf8287 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -5,6 +5,14 @@ Overview of available features .. div:: dropdown-group + .. dropdown:: Data Sources + + Dropdown content + + .. dropdown:: Data Filters + + Dropdown content + .. dropdown:: Descriptor Sets :class:`~qsprpred.data.descriptors.sets.DescriptorSet`: Base class for descriptor sets. @@ -50,7 +58,30 @@ Overview of available features * :class:`~qsprpred.extra.data.descriptors.fingerprints.CDKPubchemFP`: CDKPubchemFP * :class:`~qsprpred.extra.data.descriptors.fingerprints.CDKSubstructureFP`: CDKSubstructureFP - .. dropdown:: Dropdown B + .. dropdown:: Data Splitters + + Dropdown content + + .. dropdown:: Feature Filters + + Dropdown content + + .. dropdown:: Models + + Dropdown content + + .. dropdown:: Metrics + + Dropdown content + + .. dropdown:: Model Assessors + + Dropdown content + + .. dropdown:: Hyperparameter Optimizers + + Dropdown content - Dropdown content B + .. dropdown:: Model Plots + Dropdown content \ No newline at end of file From c0d4c29b7b0757722d5a0c8e053d592fc2f32a17 Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Fri, 2 Feb 2024 16:09:14 +0100 Subject: [PATCH 03/18] add sources to featurlist --- docs/features.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/features.rst b/docs/features.rst index dbaf8287..5e34af58 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -7,7 +7,14 @@ Overview of available features .. dropdown:: Data Sources - Dropdown content + :class:`~qsprpred.data.sources.data_source.DataSource`: Base class for data sources. + Data sources are used to load data from a source programmatically. + + .. tab-set:: + + .. tab-item:: Core + + * :class:`~qsprpred.data.sources.papyrus.papyrus_class.Papyrus`: Papyrus .. dropdown:: Data Filters From 6ea668b81e815b2a82bf63c0a7438874d0115da8 Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Fri, 2 Feb 2024 16:16:48 +0100 Subject: [PATCH 04/18] add data filters to feature list --- docs/features.rst | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/features.rst b/docs/features.rst index 5e34af58..ce505914 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -8,6 +8,7 @@ Overview of available features .. dropdown:: Data Sources :class:`~qsprpred.data.sources.data_source.DataSource`: Base class for data sources. + Data sources are used to load data from a source programmatically. .. tab-set:: @@ -18,11 +19,21 @@ Overview of available features .. dropdown:: Data Filters - Dropdown content + :class:`~qsprpred.data.processing.data_filters.DataFilter`: Base class for data filters. + + Data filters are used to filter data based on some criteria. + + .. tab-set:: + + .. tab-item:: Core + + * :class:`~qsprpred.data.processing.data_filters.CategoryFilter`: CategoryFilter + * :class:`~qsprpred.data.processing.data_filters.RepeatsFilter`: RepeatsFilter .. dropdown:: Descriptor Sets - :class:`~qsprpred.data.descriptors.sets.DescriptorSet`: Base class for descriptor sets. + :class:`~qsprpred.data.descriptors.sets.DescriptorSet`: Base class for descriptor sets. + Descriptor sets are used to calculate molecular descriptors for a set of molecules. .. tab-set:: From e393281be1a85a210f44f9063712e641b1942c93 Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Fri, 2 Feb 2024 16:38:33 +0100 Subject: [PATCH 05/18] add data splitters to feature list --- docs/features.rst | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/features.rst b/docs/features.rst index ce505914..f90f0e77 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -33,7 +33,7 @@ Overview of available features .. dropdown:: Descriptor Sets :class:`~qsprpred.data.descriptors.sets.DescriptorSet`: Base class for descriptor sets. - + Descriptor sets are used to calculate molecular descriptors for a set of molecules. .. tab-set:: @@ -78,7 +78,29 @@ Overview of available features .. dropdown:: Data Splitters - Dropdown content + :class:`~qsprpred.data.sampling.splits.DataSplit`: Base class for data splitters. + + Data splitters are used to split data into training and test sets. + + .. tab-set:: + + .. tab-item:: Core + + * :class:`~qsprpred.data.sampling.splits.RandomSplit`: RandomSplit + * :class:`~qsprpred.data.sampling.splits.ScaffoldSplit`: ScaffoldSplitter + * :class:`~qsprpred.data.sampling.splits.TemporalSplit`: StratifiedSplitter + * :class:`~qsprpred.data.sampling.splits.ManualSplit`: ManualSplit + * :class:`~qsprpred.data.sampling.splits.BootstrapSplit`: BootstrapSplit + * :class:`~qsprpred.data.sampling.splits.GBMTDataSplit`: GBMTDataSplit + * :class:`~qsprpred.data.sampling.splits.GBMTRandomSplit`: GBMTRandomSplit + * :class:`~qsprpred.data.sampling.splits.ClusterSplit`: ClusterSplit + + .. tab-item:: Extra + + * :class:`~qsprpred.extra.data.sampling.splits.LeaveTargetsOut`: LeaveTargetsOut + * :class:`~qsprpred.extra.data.sampling.splits.PCMSplit`: PCMSplit + * :class:`~qsprpred.extra.data.sampling.splits.TemporalPerTarget`: TemporalPerTarget + .. dropdown:: Feature Filters From b1f90e14c6ef94a6f90450ac07aa85691151b455 Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Fri, 2 Feb 2024 17:05:20 +0100 Subject: [PATCH 06/18] add feature filters to feature listt --- docs/features.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/features.rst b/docs/features.rst index f90f0e77..cd8e7005 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -104,7 +104,17 @@ Overview of available features .. dropdown:: Feature Filters - Dropdown content + :class:`~qsprpred.data.processing.feature_filters.FeatureFilter`: Base class for feature filters. + + Feature filters are used to filter features based on some criteria. + + .. tab-set:: + + .. tab-item:: Core + + * :class:`~qsprpred.data.processing.feature_filters.HighCorrelationFilter`: HighCorrelationFilter + * :class:`~qsprpred.data.processing.feature_filters.LowVarianceFilter`: LowVarianceFilter + * :class:`~qsprpred.data.processing.feature_filters.BorutaFilter`: BorutaFilter .. dropdown:: Models From 081061585a8b6aebd745c52d64112ef232f12f48 Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Fri, 2 Feb 2024 17:54:01 +0100 Subject: [PATCH 07/18] add models to featurelist --- docs/features.rst | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/features.rst b/docs/features.rst index cd8e7005..9686d85b 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -118,7 +118,24 @@ Overview of available features .. dropdown:: Models - Dropdown content + :class:`~qsprpred.models.models.QSPRModel`: Base class for models. + + Models are used to predict properties of molecules. + + .. tab-set:: + + .. tab-item:: Core + + * :class:`~qsprpred.models.scikit_learn.SklearnModel`: SklearnModel + + .. tab-item:: Extra + + * :class:`~qsprpred.extra.models.pcm.PCMModel`: PCMModel + + .. tab-item:: GPU + + * :class:`~qsprpred.extra.gpu.models.chemprop.ChempropModel`: ChempropModel + * :class:`~qsprpred.extra.gpu.models.pyboost.PyBoostModel`: PyBoostModel .. dropdown:: Metrics From e878653c19262a3cabef4c3f399bb3d2f6879aab Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Fri, 2 Feb 2024 18:03:08 +0100 Subject: [PATCH 08/18] add metrics to featurelist --- docs/features.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/features.rst b/docs/features.rst index 9686d85b..a8cff6c5 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -139,7 +139,15 @@ Overview of available features .. dropdown:: Metrics - Dropdown content + :class:`~qsprpred.models.metrics.Metric`: Base class for metrics + + Metrics are used to evaluate the performance of models. + + .. tab-set:: + + .. tab-item:: Core + + * :class:`~qsprpred.models.metrics.SklearnMetrics`: SklearnMetrics .. dropdown:: Model Assessors From 164922693b9765af5c587ddd0d2058a0b0c468a4 Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Fri, 2 Feb 2024 18:06:37 +0100 Subject: [PATCH 09/18] add model assessors to feature list --- docs/features.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/features.rst b/docs/features.rst index a8cff6c5..40091b28 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -151,7 +151,16 @@ Overview of available features .. dropdown:: Model Assessors - Dropdown content + :class:`~qsprpred.models.assessment_methods.ModelAssessor`: Base class for model assessors. + + Model assessors are used to assess the performance of models. + + .. tab-set:: + + .. tab-item:: Core + + * :class:`~qsprpred.models.assessment_methods.CrossValAssessor`: CrossValAssessor + * :class:`~qsprpred.models.assessment_methods.TestSetAssessor`: TestSetAssessor .. dropdown:: Hyperparameter Optimizers From b753c18ec8988433db2a8d58c5a048f04177c725 Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Fri, 2 Feb 2024 18:37:50 +0100 Subject: [PATCH 10/18] add hyperparam optimizers to feature list --- docs/features.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/features.rst b/docs/features.rst index 40091b28..3bc8d2fe 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -164,7 +164,17 @@ Overview of available features .. dropdown:: Hyperparameter Optimizers - Dropdown content + :class:`~qsprpred.models.hyperparam_optimization.HyperparameterOptimizion`: Base class for hyperparameter optimizers. + + Hyperparameter optimizers are used to optimize the hyperparameters of models. + + .. tab-set:: + + .. tab-item:: Core + + * :class:`~qsprpred.models.hyperparam_optimization.GridSearchOptimization`: GridSearchOptimization + * :class:`~qsprpred.models.hyperparam_optimization.OptunaOptimization`: OptunaOptimization + .. dropdown:: Model Plots From 8e65c07aedf38f5b5129c8465d631b7f2e237be4 Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Fri, 2 Feb 2024 18:50:55 +0100 Subject: [PATCH 11/18] add model plot --- docs/features.rst | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/features.rst b/docs/features.rst index 3bc8d2fe..4ba90f7e 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -164,7 +164,7 @@ Overview of available features .. dropdown:: Hyperparameter Optimizers - :class:`~qsprpred.models.hyperparam_optimization.HyperparameterOptimizion`: Base class for hyperparameter optimizers. + :class:`~qsprpred.models.hyperparam_optimization.HyperparameterOptimization`: Base class for hyperparameter optimizers. Hyperparameter optimizers are used to optimize the hyperparameters of models. @@ -178,4 +178,21 @@ Overview of available features .. dropdown:: Model Plots - Dropdown content \ No newline at end of file + :class:`~qsprpred.plotting.base_plot.ModelPlot`: Base class for model plots. + + Model plots are used to visualize the performance of models. + + .. tab-set:: + + .. tab-item:: Core + + * :class:`~qsprpred.plotting.regression.RegressionPlot`: RegressionPlot + * :class:`~qsprpred.plotting.regression.CorrelationPlot`: CorrelationPlot + * :class:`~qsprpred.plotting.regression.WilliamsPlot`: WilliamsPlot + * :class:`~qsprpred.plotting.classification.ClassifierPlot`: ClassifierPlot + * :class:`~qsprpred.plotting.classification.ROCPlot`: ROCPlot + * :class:`~qsprpred.plotting.classification.PRCPlot`: PRCPlot + * :class:`~qsprpred.plotting.classification.CalibrationPlot`: CalibrationPlot + * :class:`~qsprpred.plotting.classification.MetricsPlot`: MetricsPlot + * :class:`~qsprpred.plotting.classification.ConfusionMatrixPlot`: ConfusionMatrixPlot + From 729140b0e74d53bbe6db8ea628c42189fe48f78f Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Mon, 5 Feb 2024 12:49:31 +0100 Subject: [PATCH 12/18] add tutorial link to features --- docs/features.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/features.rst b/docs/features.rst index 4ba90f7e..9bdfc019 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -10,6 +10,7 @@ Overview of available features :class:`~qsprpred.data.sources.data_source.DataSource`: Base class for data sources. Data sources are used to load data from a source programmatically. + An example may be found in the `tutorial `_. .. tab-set:: From b1b036af3c1c48821b8d935298b5a29b0ee9d6f1 Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Mon, 5 Feb 2024 14:06:57 +0100 Subject: [PATCH 13/18] add tutorial links --- docs/features.rst | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/features.rst b/docs/features.rst index 9bdfc019..dcb0109f 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -10,7 +10,7 @@ Overview of available features :class:`~qsprpred.data.sources.data_source.DataSource`: Base class for data sources. Data sources are used to load data from a source programmatically. - An example may be found in the `tutorial `_. + An example may be found in the `data collection with Papyrus tutorial `_. .. tab-set:: @@ -23,6 +23,7 @@ Overview of available features :class:`~qsprpred.data.processing.data_filters.DataFilter`: Base class for data filters. Data filters are used to filter data based on some criteria. + Examples can be found in the `data preparation tutorial `_. .. tab-set:: @@ -36,6 +37,7 @@ Overview of available features :class:`~qsprpred.data.descriptors.sets.DescriptorSet`: Base class for descriptor sets. Descriptor sets are used to calculate molecular descriptors for a set of molecules. + Examples can be found in the `descriptor calculation tutorial `_. .. tab-set:: @@ -82,6 +84,7 @@ Overview of available features :class:`~qsprpred.data.sampling.splits.DataSplit`: Base class for data splitters. Data splitters are used to split data into training and test sets. + Examples may be found in the `data splitting tutorial `_. .. tab-set:: @@ -108,6 +111,7 @@ Overview of available features :class:`~qsprpred.data.processing.feature_filters.FeatureFilter`: Base class for feature filters. Feature filters are used to filter features based on some criteria. + Examples can be found in the `data preparation tutorial `_. .. tab-set:: @@ -122,20 +126,27 @@ Overview of available features :class:`~qsprpred.models.models.QSPRModel`: Base class for models. Models are used to predict properties of molecules. + A general example may be found in the `quick start tutorial `_. + More detailed information can be found throughouth the basic and advanced modelling tutorials. .. tab-set:: .. tab-item:: Core * :class:`~qsprpred.models.scikit_learn.SklearnModel`: SklearnModel + An example may be found in the `quick start tutorial `_. .. tab-item:: Extra * :class:`~qsprpred.extra.models.pcm.PCMModel`: PCMModel + More information may be found in the `PCM tutorial `_. .. tab-item:: GPU - + More information may be found in the `deep learning tutorial `_. + + * :class:`~qsprpred.extra.gpu.models.dnn.DNNModel`: DNNModel * :class:`~qsprpred.extra.gpu.models.chemprop.ChempropModel`: ChempropModel + More information may be found in the `Chemprop tutorial `_. * :class:`~qsprpred.extra.gpu.models.pyboost.PyBoostModel`: PyBoostModel .. dropdown:: Metrics @@ -143,6 +154,7 @@ Overview of available features :class:`~qsprpred.models.metrics.Metric`: Base class for metrics Metrics are used to evaluate the performance of models. + More information may be found in the `model assessment tutorial `_. .. tab-set:: @@ -155,6 +167,7 @@ Overview of available features :class:`~qsprpred.models.assessment_methods.ModelAssessor`: Base class for model assessors. Model assessors are used to assess the performance of models. + Examples may be found in the `model assessment tutorial `_. .. tab-set:: @@ -168,6 +181,7 @@ Overview of available features :class:`~qsprpred.models.hyperparam_optimization.HyperparameterOptimization`: Base class for hyperparameter optimizers. Hyperparameter optimizers are used to optimize the hyperparameters of models. + More information may be found in the `hyperparameter optimization tutorial `_. .. tab-set:: @@ -182,6 +196,7 @@ Overview of available features :class:`~qsprpred.plotting.base_plot.ModelPlot`: Base class for model plots. Model plots are used to visualize the performance of models. + Examples can be found throughout the basic and advanced modelling tutorials. .. tab-set:: From 0750af44bb240c10ae2adf45d12eb41aa93dbd0b Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Mon, 5 Feb 2024 14:58:12 +0100 Subject: [PATCH 14/18] fix tutorial references --- docs/features.rst | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/docs/features.rst b/docs/features.rst index dcb0109f..cebe3cde 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -10,13 +10,12 @@ Overview of available features :class:`~qsprpred.data.sources.data_source.DataSource`: Base class for data sources. Data sources are used to load data from a source programmatically. - An example may be found in the `data collection with Papyrus tutorial `_. .. tab-set:: .. tab-item:: Core - * :class:`~qsprpred.data.sources.papyrus.papyrus_class.Papyrus`: Papyrus + * :class:`~qsprpred.data.sources.papyrus.papyrus_class.Papyrus`: Papyrus (See `data collection with Papyrus tutorial `_.) .. dropdown:: Data Filters @@ -84,7 +83,7 @@ Overview of available features :class:`~qsprpred.data.sampling.splits.DataSplit`: Base class for data splitters. Data splitters are used to split data into training and test sets. - Examples may be found in the `data splitting tutorial `_. + Examples can be found in the `data splitting tutorial `_. .. tab-set:: @@ -126,27 +125,25 @@ Overview of available features :class:`~qsprpred.models.models.QSPRModel`: Base class for models. Models are used to predict properties of molecules. - A general example may be found in the `quick start tutorial `_. - More detailed information can be found throughouth the basic and advanced modelling tutorials. + A general example can be found in the `quick start tutorial `_. + More detailed information can be found throughout the basic and advanced modelling tutorials. .. tab-set:: .. tab-item:: Core * :class:`~qsprpred.models.scikit_learn.SklearnModel`: SklearnModel - An example may be found in the `quick start tutorial `_. .. tab-item:: Extra - * :class:`~qsprpred.extra.models.pcm.PCMModel`: PCMModel - More information may be found in the `PCM tutorial `_. + * :class:`~qsprpred.extra.models.pcm.PCMModel`: PCMModel (See `PCM tutorial `_.) .. tab-item:: GPU - More information may be found in the `deep learning tutorial `_. + + More information can be found in the `deep learning tutorial `_. * :class:`~qsprpred.extra.gpu.models.dnn.DNNModel`: DNNModel - * :class:`~qsprpred.extra.gpu.models.chemprop.ChempropModel`: ChempropModel - More information may be found in the `Chemprop tutorial `_. + * :class:`~qsprpred.extra.gpu.models.chemprop.ChempropModel`: ChempropModel (See `Chemprop tutorial `_.) * :class:`~qsprpred.extra.gpu.models.pyboost.PyBoostModel`: PyBoostModel .. dropdown:: Metrics @@ -154,7 +151,7 @@ Overview of available features :class:`~qsprpred.models.metrics.Metric`: Base class for metrics Metrics are used to evaluate the performance of models. - More information may be found in the `model assessment tutorial `_. + More information can be found in the `model assessment tutorial `_. .. tab-set:: @@ -167,7 +164,7 @@ Overview of available features :class:`~qsprpred.models.assessment_methods.ModelAssessor`: Base class for model assessors. Model assessors are used to assess the performance of models. - Examples may be found in the `model assessment tutorial `_. + More information be found in the `model assessment tutorial `_. .. tab-set:: @@ -181,7 +178,7 @@ Overview of available features :class:`~qsprpred.models.hyperparam_optimization.HyperparameterOptimization`: Base class for hyperparameter optimizers. Hyperparameter optimizers are used to optimize the hyperparameters of models. - More information may be found in the `hyperparameter optimization tutorial `_. + More information can be found in the `hyperparameter optimization tutorial `_. .. tab-set:: From 9e1074ea2172779bf20262d33aee9298fd96fe12 Mon Sep 17 00:00:00 2001 From: maagdenbehwvanden1 Date: Mon, 5 Feb 2024 15:37:22 +0100 Subject: [PATCH 15/18] update documentation installation and index --- docs/{use.rst => cli_usage.rst} | 9 ++++----- docs/conf.py | 1 + docs/index.rst | 10 +++++----- docs/install.rst | 21 ++++++++++++++++++++- 4 files changed, 30 insertions(+), 11 deletions(-) rename docs/{use.rst => cli_usage.rst} (99%) diff --git a/docs/use.rst b/docs/cli_usage.rst similarity index 99% rename from docs/use.rst rename to docs/cli_usage.rst index 79f4ea33..b5442eb5 100644 --- a/docs/use.rst +++ b/docs/cli_usage.rst @@ -1,7 +1,7 @@ -.. _usage: +.. _cli-usage: -Usage -===== +Command Line Interface Usage +============================ You can use the command-line interface to preprocess data and build models. The description of the functionality can be displayed with the :code:`--help` argument, @@ -18,10 +18,9 @@ you can also use the Python API directly (see `source code `_. .. toctree:: :maxdepth: 2 @@ -17,7 +17,7 @@ Here you will find the installation guide (:ref:`installation`), an overview of self install - use + cli_usage features api/modules diff --git a/docs/install.rst b/docs/install.rst index b4136b5f..9b4d107c 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -3,7 +3,7 @@ Installation ============ -You do not need anything special to install the package. Just run the following to get the latest version and all dependencies: +You do not need anything special to install the package . Just run the following (with python >= 3.10) to get the latest version and all basic dependencies: .. code-block:: @@ -11,6 +11,25 @@ You do not need anything special to install the package. Just run the following You can also get tags and development snapshots by varying the :code:`@main` part (i.e. :code:`@1.0.0`). After that you can start building models (see :ref:`usage`). +Note that this will install the basic dependencies, but not the optional dependencies. +If you want to use the optional dependencies, you can install the package with an +option: + +.. code-block:: + + pip install git+https://github.com/CDDLeiden/QSPRpred.git@main#egg=qsprpred[