Skip to content

Commit

Permalink
Update citation in RTD, rlease notes
Browse files Browse the repository at this point in the history
  • Loading branch information
breimanntools committed Apr 19, 2024
1 parent 7a487c3 commit 31c407b
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
6 changes: 2 additions & 4 deletions docs/source/index/citations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@ If you use **AAanalysis** in your work, please cite the respective publication a

**CPP**:
[Breimann24c]_ Breimann and Kamp *et al.* (2024c),
*Interpretable feature engineering by CPP reveals the physicochemical signature of γ-secretase substrates*,
.. # Link if available
*Charting γ-secretase substrates by explainable AI*, .. # Link if available

**dPULearn**:
[Breimann24c]_ Breimann and Kamp *et al.* (2024c),
*Interpretable feature engineering by CPP reveals the physicochemical signature of γ-secretase substrates*,
.. # Link if available
*Charting γ-secretase substrates by explainable AI*, .. # Link if available
7 changes: 4 additions & 3 deletions docs/source/index/evaluation/eval_aaclust.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,11 @@ AAnalysis focuses on three common clustering quality measures to evaluate cluste
These measures are essential in assessing the distinct aspects of clustering quality, such as within-cluster cohesion
and between-cluster separation, depicted below:

.. image:: /_artwork/schemes/scheme_AAclust3.png
.. figure:: /_artwork/schemes/scheme_AAclust3.png
:align: center
:alt: Evaluation measures for clustering.


Illustration of clustering quality measures from [Breimann24b]_.
Illustration of clustering quality measures from [Breimann24b]_.

To learn more about clustering and its evaluation in detail, you may refer to the
`scikit-learn clustering <https://scikit-learn.org/stable/modules/clustering.html>`_ documentation.
2 changes: 1 addition & 1 deletion docs/source/index/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Added
~~~~~
- **Installation Options**: Introduced separate installation profiles for the core and professional versions.
The **core version** has reduced dependencies to enhance installation robustness, installable using ``pip install aaanalysis``.
The professional version, designed for advanced usage, includes packages required for our explainable AI module
The **professional version**, designed for advanced usage, includes packages required for our explainable AI module
such as SHAP, installable using ``pip install aaanalysis[pro]``.

Changed
Expand Down

0 comments on commit 31c407b

Please sign in to comment.