Skip to content

[docs] Update "About Pipelines" list#1889

Merged
samfreund merged 11 commits intoPhotonVision:mainfrom
alaninnovates:docs-pipeline-types
Apr 13, 2025
Merged

[docs] Update "About Pipelines" list#1889
samfreund merged 11 commits intoPhotonVision:mainfrom
alaninnovates:docs-pipeline-types

Conversation

@alaninnovates
Copy link
Contributor

@alaninnovates alaninnovates commented Apr 13, 2025

Description

In the About Pipelines page, move the reflective pipeline down the list because students don't encounter this after FIRST removed it from their games. Also, mention object detection as a pipeline type.

Closes #1849

Meta

Merge checklist:

  • Pull Request title is short, imperative summary of proposed changes
  • The description documents the what and why
  • If this PR changes behavior or adds a feature, user documentation is updated
  • If this PR touches photon-serde, all messages have been regenerated and hashes have not changed unexpectedly
  • If this PR touches configuration, this is backwards compatible with settings back to v2024.3.1
  • If this PR touches pipeline settings or anything related to data exchange, the frontend typing is updated
  • If this PR addresses a bug, a regression test for it is added

@alaninnovates alaninnovates requested a review from a team as a code owner April 13, 2025 16:37
Copy link
Member

@samfreund samfreund left a comment

Choose a reason for hiding this comment

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

Can you move reflective to under colored shapes, as colored shapes are more likely to be used than reflective? If you could add a note under reflective that it is no longer used as well, that would be great.

Listing the steps and different inputs for the object detection pipeline at the bottom would be great too.

@alaninnovates alaninnovates requested a review from samfreund April 13, 2025 16:58
Copy link
Member

@samfreund samfreund left a comment

Choose a reason for hiding this comment

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

Sorry, looks like I should've been more clear. I was hoping you could add the different input options under the pipeline steps section, similar to how the inputs for the other pipelines are explained.

@alaninnovates
Copy link
Contributor Author

Do you mean in the actual "About Object Detection" page? I just read it and it does touch on some of the sliders. Should I clarify confidence more?

@samfreund
Copy link
Member

Do you mean in the actual "About Object Detection" page? I just read it and it does touch on some of the sliders. Should I clarify confidence more?

At the bottom of page you're currently editing, there's a section called pipeline steps.

@samfreund
Copy link
Member

samfreund commented Apr 13, 2025

Looking really good!

You can probably remove this sentence

In the object detection tab of this pipeline type, you can configure the confidence threshold and apply filters based on area and width/height ratio.

as its covered below.

Edit: completed

@alaninnovates alaninnovates requested a review from samfreund April 13, 2025 18:36
@alaninnovates
Copy link
Contributor Author

Instead of referring to each tab as a "step", should we just refer to them as tabs? (i.e. "Pipeline Tabs")

@samfreund
Copy link
Member

Instead of referring to each tab as a "step", should we just refer to them as tabs? (i.e. "Pipeline Tabs")

Yeah, I agree. Otherwise, looks good.

@samfreund samfreund enabled auto-merge (squash) April 13, 2025 19:03
@samfreund samfreund merged commit cbdea5d into PhotonVision:main Apr 13, 2025
39 checks passed
samfreund added a commit to samfreund/photonvision that referenced this pull request Apr 14, 2025
@Gold856 Gold856 added the documentation Anything relating to https://docs.photonvision.org label Jul 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Anything relating to https://docs.photonvision.org

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] Mention object detection as type of pipeline

4 participants