8000 Broken image in MDS user guide documentation · Issue #22061 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

Broken image in MDS user guide documentation #22061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
glemaitre opened this issue Dec 22, 2021 · 13 comments · Fixed by #22465
Closed

Broken image in MDS user guide documentation #22061

glemaitre opened this issue Dec 22, 2021 · 13 comments · Fixed by #22465
Labels
Documentation High Priority High priority issues and pull requests Moderate Anything that requires some knowledge of conventions and best practices
Milestone
1.1

Comments

@glemaitre
Copy link
Member

Describe the issue linked to the documentation

I can see that the image in the documentation of MDS is not present:
https://scikit-learn.org/stable/modules/manifold.html#multi-dimensional-scaling-mds

Suggest a potential alternative/fix

We should change the hyperlink to have something similar to the previous version:
https://scikit-learn.org/0.24/modules/manifold.html#multi-dimensional-scaling-mds
@glemaitre glemaitre added Documentation Needs Triage Issue requires triage Easy Well-defined and straightforward way to resolve help wanted and removed Needs Triage Issue requires triage labels Dec 22, 2021
@tejaswari7
Copy link

I would like to take this issue

@glemaitre
Copy link
Member Author

@tejaswari7 I assigned you this issue.

@tejaswari7
Copy link

When I opened image in new tab, it says page not found. as shown in the attached Screenshot

image

I think maybe the source of image has been removed.

@glemaitre
Copy link
Member Author

It was indeed my point that the URL does not work :)

We generate the images with the example. In this case, we generate the images from:
https://scikit-learn.org/dev/auto_examples/manifold/plot_lle_digits.html#sphx-glr-auto-examples-manifold-plot-lle-digits-py

So basically we need to link to this image: https://scikit-learn.org/dev/_images/sphx_glr_plot_lle_digits_002.png

I assume that changing sphx_glr_plot_lle_digits_010.png by sphx_glr_plot_lle_digits_002.png should be enough.

@tejaswari7
Copy link

I made changes, but I can't preview the changes.
How can I preview the changes made to the documentation?

@glemaitre
Copy link
Member Author

You need to build the documentation locally: https://scikit-learn.org/dev/developers/contributing.html#building-the-documentation

When submitting a PR, you need to add the tag [doc build] in the name of your commit to trigger a documentation build.

@tejaswari7
Copy link

When I tried to build scikit-learn locally, I encountered the following error, as shown in attached in screenshot.

image

Where can I find the files setup.py & pyproject.toml?

@glemaitre
Copy link
Member Author

You are not in the right directory. Please follow the installation guideline for this part: https://scikit-learn.org/stable/developers/advanced_installation.html#building-from-source

@tejaswari7
Copy link

I ran the command pytest doc/modules/linear_model.rst but the test failed.
image

is there need to perform testing?

@Jyotika2001
Copy link

Has this issue been solved? If not, I would like to work on it.

@Jyotika2001
Copy link

@glemaitre If you could please tell me where I will find this file, I will make the required change.

This was referenced Jan 10, 2022
Closed
Closed
Closed
@tejaswari7
Copy link

I ran the command pytest doc/modules/linear_model.rst but the test failed. image

is there need to perform testing?

@glemaitre please give your suggestions on this so that I can proceed further!!

@glemaitre glemaitre mentioned this issue Jan 10, 2022
Closed
@thomasjpfan thomasjpfan added Moderate Anything that requires some knowledge of conventions and best practices and removed Easy Well-defined and straightforward way to resolve labels Jan 12, 2022
@tejaswari7 tejaswari7 removed their assignment Jan 24, 2022
@cmarmo cmarmo mentioned this issue Feb 3, 2022
Open
@thomasjpfan thomasjpfan added this to the 1.1 milestone Feb 3, 2022
@thomasjpfan thomasjpfan added the High Priority High priority issues and pull requests label Feb 3, 2022
This was referenced Feb 12, 2022
Closed
Merged
@Micky774
Copy link
Contributor

I believe I have a fix for this in #22465

@cmarmo cmarmo mentioned this issue Oct 30, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation High Priority High priority issues and pull requests Moderate Anything that requires some knowledge of conventions and best practices
Projects
None yet
Milestone
1.1
6 participants
@cmarmo @thomasjpfan @glemaitre @Micky774 @tejaswari7 @Jyotika2001
0