DOC Added references to plot_ica_blind_source_separation & plot_ica_vs_pca.py by V-Rang · Pull Request #30786 · scikit-learn/scikit-learn

V-Rang · 2025-02-08T08:19:46Z

Reference Issues/PRs

Towards #30621

What does this implement/fix? Explain your changes.

Added references to files plot_ica_blind_source_separation.py & plot_ica_vs_pca.py under description of PCA in "Decomposing signals in components"
Both plot_ica_blind_source_separation.py & plot_ica_vs_pca.py compare PCA & ICA performance for different tasks -- signal source estimation and component analysis, so added references to the other example under each.

github-actions · 2025-02-08T08:21:04Z

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

_{Generated for commit: b1399d6. Link to the linter CI: here}

virchan

Thank you for the PR @V-Rang!

I have a few comments:

virchan · 2025-02-09T03:32:07Z

doc/modules/decomposition.rst

+* :ref:`sphx_glr_auto_examples_decomposition_plot_ica_vs_pca.py`
 * :ref:`sphx_glr_auto_examples_decomposition_plot_pca_vs_fa_model_selection.py`
-
+* :ref:`sphx_glr_auto_examples_decomposition_plot_ica_blind_source_separation.py`


Since the examples involve ICA, I think it would be better to move them to the ICA section.

Hi @virchan , thanks a lot for the feedback. I had placed the reference to plot_ica_vs_pca.py here (under the PCA section), since it involves both ICA and PCA. A reference to this example was already there under the ICA section, so I felt it would be appropriate to place a reference under the PCA section as well. I will remove the reference from here if you insist. Please let me know.

Since both plot_ica_vs_pca.py and plot_ica_blind_source_separation.py are already referenced in the ICA section, I suggest removing them here.

Thanks a lot for the feedback. There are no changes to be made then for these examples. I will update at #30621 and move onto other examples. I am closing this pull request. Thanks for getting back to me so quickly!

virchan · 2025-02-09T03:38:29Z

examples/decomposition/plot_ica_blind_source_separation.py

+See
+:ref:`sphx_glr_auto_examples_decomposition_plot_ica_vs_pca.py`
+for an example comparing the component analysis by ICA and PCA.


I don't think we need this here. Could you please move it to the ICA and PCA documentation?

Hi @virchan, thank you for the feedback. In https://github.com/scikit-learn/scikit-learn/pull/30786/files/765c02200face8d8a88adeb3fc3bae78cc626b33#r1947998397, you mentioned, removing the reference to plot_ica_vs_pca.py from under the PCA section. So, I am not clear if you want a reference placed there or not. (I may be completely wrong in where you want the reference placed. Please correct me if possible).

I don't think it’s necessary to reference plot_ica_vs_pca.py within plot_ica_blind_source_separation.py.

virchan · 2025-02-09T03:39:07Z

examples/decomposition/plot_ica_vs_pca.py

+See
+:ref:`sphx_glr_auto_examples_decomposition_plot_ica_blind_source_separation.py`
+for an example comparing the performance of ICA and PCA in estimating sources
+from noisy data.


Could you please move it to the ICA and PCA documentation as well?

References to both examples are already in the ICA section from earlier. I will remove these references from here. Thanks a lot for the feedback.

I believe referencing plot_ica_blind_source_separation.py in plot_ica_vs_pca.py isn’t needed.

V-Rang

Please clarify feedback if possible.

V-Rang · 2025-02-09T06:26:35Z

examples/decomposition/plot_ica_blind_source_separation.py

+See
+:ref:`sphx_glr_auto_examples_decomposition_plot_ica_vs_pca.py`
+for an example comparing the component analysis by ICA and PCA.


Hi @virchan, thank you for the feedback. In https://github.com/scikit-learn/scikit-learn/pull/30786/files/765c02200face8d8a88adeb3fc3bae78cc626b33#r1947998397, you mentioned, removing the reference to plot_ica_vs_pca.py from under the PCA section. So, I am not clear if you want a reference placed there or not. (I may be completely wrong in where you want the reference placed. Please correct me if possible).

V-Rang · 2025-02-09T06:26:40Z

doc/modules/decomposition.rst

+* :ref:`sphx_glr_auto_examples_decomposition_plot_ica_vs_pca.py`
 * :ref:`sphx_glr_auto_examples_decomposition_plot_pca_vs_fa_model_selection.py`
-
+* :ref:`sphx_glr_auto_examples_decomposition_plot_ica_blind_source_separation.py`


Hi @virchan , thanks a lot for the feedback. I had placed the reference to plot_ica_vs_pca.py here (under the PCA section), since it involves both ICA and PCA. A reference to this example was already there under the ICA section, so I felt it would be appropriate to place a reference under the PCA section as well. I will remove the reference from here if you insist. Please let me know.

V-Rang · 2025-02-09T06:26:43Z

examples/decomposition/plot_ica_vs_pca.py

+See
+:ref:`sphx_glr_auto_examples_decomposition_plot_ica_blind_source_separation.py`
+for an example comparing the performance of ICA and PCA in estimating sources
+from noisy data.


References to both examples are already in the ICA section from earlier. I will remove these references from here. Thanks a lot for the feedback.

virchan

Thank you for following up @V-Rang!

Could you please add plot_ica_blind_source_separation.py and plot_ica_vs_pca.py to the FastICA documentation?

Additionally:

virchan · 2025-02-10T21:35:20Z

doc/modules/decomposition.rst

+* :ref:`sphx_glr_auto_examples_decomposition_plot_ica_vs_pca.py`
 * :ref:`sphx_glr_auto_examples_decomposition_plot_pca_vs_fa_model_selection.py`
-
+* :ref:`sphx_glr_auto_examples_decomposition_plot_ica_blind_source_separation.py`


Since both plot_ica_vs_pca.py and plot_ica_blind_source_separation.py are already referenced in the ICA section, I suggest removing them here.

virchan · 2025-02-10T21:39:55Z

examples/decomposition/plot_ica_blind_source_separation.py

+See
+:ref:`sphx_glr_auto_examples_decomposition_plot_ica_vs_pca.py`
+for an example comparing the component analysis by ICA and PCA.


I don't think it’s necessary to reference plot_ica_vs_pca.py within plot_ica_blind_source_separation.py.

virchan · 2025-02-10T21:41:56Z

examples/decomposition/plot_ica_vs_pca.py

+See
+:ref:`sphx_glr_auto_examples_decomposition_plot_ica_blind_source_separation.py`
+for an example comparing the performance of ICA and PCA in estimating sources
+from noisy data.


I believe referencing plot_ica_blind_source_separation.py in plot_ica_vs_pca.py isn’t needed.

V-Rang added 4 commits February 7, 2025 18:01

placed reference to pca vs ica example

d499b93

references to other

6ab15e8

reference to pca performance on signal detection

40d298d

Merge branch 'main' into feature

a6a568b

github-actions bot added the Documentation label Feb 8, 2025

Merge branch 'main' into feature

765c022

virchan reviewed Feb 9, 2025

View reviewed changes

V-Rang commented Feb 9, 2025

View reviewed changes

virchan reviewed Feb 10, 2025

View reviewed changes

modifications made

b1399d6

V-Rang closed this Feb 10, 2025

V-Rang mentioned this pull request Feb 10, 2025

Add links to examples from the docstrings and user guide #30621

Closed

V-Rang deleted the feature branch February 10, 2025 22:25

Uh oh!

Conversation

V-Rang commented Feb 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Uh oh!

github-actions bot commented Feb 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✔️ Linting Passed

Uh oh!

virchan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

V-Rang left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

virchan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

V-Rang commented Feb 8, 2025 •

edited

Loading

github-actions bot commented Feb 8, 2025 •

edited

Loading