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

Docs/add keypoint detection #372

Merged

Conversation

LinasKo
Copy link
Contributor

@LinasKo LinasKo commented May 2, 2024

Description

  • Added mentions to KeyPoints in index.md
  • Added an extensive dedicated page for keypoint detection, which should answer most questions users may have.

⚠️ Issues that affect other docs such as markdown formatting of collapsable panes was not tackled.
⚠️ We don't yet have YOLO NAS keypoint models on Universe, so I did not mention it.

Type of change

  • This change requires a documentation update

How has this change been tested, please provide a testcase or example of how you tested the change?

I've built the docs with mkdocs build, served with mkdocs serve, visually checked for unclear parts.

It would be good to have some extra eyes on this.

Any specific deployment considerations

Installation of mkdocs dependencies is outdated.

Here's my requirements/requirements.docs.txt file:

mike==1.1.2
mkdocs~=1.5.3
mkdocs-material==9.5.18
mkdocstrings-python
mkdocs-swagger-ui-tag==0.6.3
pillow
cairosvg
mkdocs-gen-files
mkdocs-literate-nav
mkdocs-macros-plugin
mkdocs-jupyter

Docs

  • Docs updated? What were the changes:
  • first paragraph of index.md
  • Mentioned keypoints detection in YOLOv8
  • new page under "Run a Model": Run Keypoint Detection

@LinasKo
Copy link
Contributor Author

LinasKo commented May 2, 2024

I'm seeing a lot of tests failing. How much of this is expected? It seems like git is failing, and docker credentials aren't configured.

Apart from that - ready for review.

@LinasKo
Copy link
Contributor Author

LinasKo commented May 2, 2024

Added InferencePipeline, tested that it works. Ready for review, assuming tests should be failing.

@grzegorz-roboflow
Copy link
Contributor

@LinasKo , I think the CI might be failing because this PR comes from the fork.

@grzegorz-roboflow grzegorz-roboflow merged commit e26dc4e into roboflow:main May 3, 2024
1 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants