Skip to content
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.

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

πŸ“š Add docs for the depth data #1694

Merged
merged 4 commits into from
Feb 1, 2024

Conversation

willyfh
Copy link
Contributor

@willyfh willyfh commented Jan 30, 2024

πŸ“ Description

This PR is based on the closed PR #1636, which adds the sphinx-based docs for depth dataset, i.e., folder 3d and mvtec 3d.

Before: there is no page for the depth dataset

depth-data

After:

image

  • πŸ› οΈ Fixes # (issue number)

✨ Changes

Select what type of change your PR is:

  • 🐞 Bug fix (non-breaking change which fixes an issue)
  • πŸ”¨ Refactor (non-breaking change which refactors the code base)
  • πŸš€ New feature (non-breaking change which adds functionality)
  • πŸ’₯ Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • πŸ“š Documentation update
  • πŸ”’ Security update

βœ… Checklist

Before you submit your pull request, please make sure you have completed the following steps:

  • πŸ“‹ I have summarized my changes in the CHANGELOG and followed the guidelines for my type of change (skip for minor changes, documentation updates, and test enhancements).
  • πŸ“š I have made the necessary updates to the documentation (if applicable).
  • πŸ§ͺ I have written tests that support my changes and prove that my fix is effective or my feature works (if applicable).

@github-actions github-actions bot added the Docs label Jan 30, 2024
Signed-off-by: Willy Fitra Hendria <[email protected]>
@willyfh willyfh marked this pull request as ready for review January 30, 2024 11:55
@willyfh willyfh requested a review from samet-akcay as a code owner January 30, 2024 11:55
Signed-off-by: Willy Fitra Hendria <[email protected]>
@willyfh willyfh requested a review from djdameln as a code owner January 30, 2024 12:19
Copy link
Contributor

@samet-akcay samet-akcay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks!

@samet-akcay samet-akcay merged commit 522ad21 into openvinotoolkit:main Feb 1, 2024
4 checks passed
adrianboguszewski pushed a commit to adrianboguszewski/anomalib that referenced this pull request Feb 9, 2024
* add sphinx-based docs for the depth data

Signed-off-by: Willy Fitra Hendria <[email protected]>

* fix formatting problem in the docstrings

Signed-off-by: Willy Fitra Hendria <[email protected]>

* remove trailing whitespace

Signed-off-by: Willy Fitra Hendria <[email protected]>

---------

Signed-off-by: Willy Fitra Hendria <[email protected]>
Co-authored-by: Samet Akcay <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants