Fixed README links #1765
Merged
Fixed README links #1765
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shir22
approved these changes
Jul 15, 2022
deepchecks/vision/README.rst
Outdated
| <p>Find outliers images with respect to the given properties. <a href="https://docs.deepchecks.com/dev/examples/vision/checks/distribution/image_property_outliers.html?utm_source=display_output&utm_medium=referral&utm_campaign=check_link" target="_blank">Read More...</a></p> | ||
| <p> | ||
| Find outliers images with respect to the given properties. | ||
| <a href="https://docs.deepchecks.com/en/stable/checks_gallery/vision/data_integrity/plot_image_property_outliers.html#sphx-glr-checks-gallery-vision-data-integrity-plot-image-property-outliers-py" target="_blank">Read More...</a> |
There was a problem hiding this comment.
Suggested change
| <a href="https://docs.deepchecks.com/en/stable/checks_gallery/vision/data_integrity/plot_image_property_outliers.html#sphx-glr-checks-gallery-vision-data-integrity-plot-image-property-outliers-py" target="_blank">Read More...</a> | |
| <a href="https://docs.deepchecks.com/en/stable/checks_gallery/vision/data_integrity/plot_image_property_outliers.html" target="_blank">Read More...</a> | |
deepchecks/vision/README.rst
Outdated
| @@ -144,8 +141,7 @@ Example for a model evaluation check calculating mAP: | |||
| <h4>Mean Average Precision Report</h4> | |||
| <p>Summarize mean average precision metrics on a dataset | |||
| and model per IoU and area range.</p> | |||
| <a href="https://https://docs.deepchecks.com/en/stable/examples/vision/checks/performance/examples/plot_mean_average_precision_report.html | |||
| utm_source=display_output&utm_medium=referral&utm_campaign=readme_check_link" target="_blank"> | |||
| <a href="https://docs.deepchecks.com/en/stable/checks_gallery/vision/model_evaluation/plot_mean_average_precision_report.html#sphx-glr-checks-gallery-vision-model-evaluation-plot-mean-average-precision-report-py" target="_blank"> | |||
There was a problem hiding this comment.
Suggested change
| <a href="https://docs.deepchecks.com/en/stable/checks_gallery/vision/model_evaluation/plot_mean_average_precision_report.html#sphx-glr-checks-gallery-vision-model-evaluation-plot-mean-average-precision-report-py" target="_blank"> | |
| <a href="https://docs.deepchecks.com/en/stable/checks_gallery/vision/model_evaluation/plot_mean_average_precision_report.html" target="_blank"> | |
There was a problem hiding this comment.
better to link to the top of the page (so that also the link for downloading the code is clearer)
There was a problem hiding this comment.
better to link to the top of the page (so that also the link for downloading the code is clearer)
@shir22 Should I have to make the mentinoned change ?
There was a problem hiding this comment.
Yes @kishore-s-15 you can just commit my suggestions before merging
ItayGabbay
requested changes
Jul 17, 2022
deepchecks/vision/README.rst
Outdated
Comment on lines
97
to
100
| ?utm_source=github.com&utm_medium=referral&utm_campaign=readme&utm_content=try_it_out>`_ | ||
| - `Deepchecks for Simple Image Classification Tutorial (for data without model) <https://docs.deepchecks.com/stable/user-guide/vision/auto_tutorials/plot_simple_classification_tutorial.html>`_ | ||
|
|
||
| - `Deepchecks for Object Detection Tutorial <https://docs.deepchecks.com/en/stable/tutorials/vision/examples/plot_detection_tutorial.html \ | ||
| ?utm_source=github.com&utm_medium=referral&utm_campaign=readme&utm_content=try_it_out>`_ | ||
| - `Deepchecks for Object Detection Tutorial <https://docs.deepchecks.com/stable/user-guide/vision/auto_tutorials/plot_detection_tutorial.html>`_ | ||
|
|
||
| - `Deepchecks for Classification Tutorial <https://docs.deepchecks.com/en/stable/tutorials/vision/examples/plot_classification_tutorial.html \ | ||
| ?utm_source=github.com&utm_medium=referral&utm_campaign=readme&utm_content=try_it_out>`_ | ||
| - `Deepchecks for Classification Tutorial <https://docs.deepchecks.com/stable/user-guide/vision/auto_tutorials/plot_classification_tutorial.html>`_ |
There was a problem hiding this comment.
The UTM parameters are important for the validation of the readme quality. Can you keep them?
deepchecks/vision/README.rst
Outdated
| <p>Find outliers images with respect to the given properties. <a href="https://docs.deepchecks.com/dev/examples/vision/checks/distribution/image_property_outliers.html?utm_source=display_output&utm_medium=referral&utm_campaign=check_link" target="_blank">Read More...</a></p> | ||
| <p> | ||
| Find outliers images with respect to the given properties. | ||
| <a href="https://docs.deepchecks.com/en/stable/checks_gallery/vision/data_integrity/plot_image_property_outliers.html#sphx-glr-checks-gallery-vision-data-integrity-plot-image-property-outliers-py" target="_blank">Read More...</a> |
There was a problem hiding this comment.
Sure, I'll make the necessary changes
…pchecks into 1756-fixed-readme-links
|
@shir22 @ItayGabbay I have made the suggested changes. Kindly let me know if there are any more changes to be made. |
|
Great @kishore-s-15 thanks! note the one suggestion for correction I just added |
ItayGabbay
approved these changes
Jul 17, 2022
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1756
Description: Fixed Project level and Vision README file links.