Skip to content

Add kmeans cli #1571

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

Merged
merged 20 commits into from
Aug 16, 2024
Merged

Add kmeans cli #1571

merged 20 commits into from
Aug 16, 2024

Conversation

k034b363
Copy link
Contributor

@k034b363 k034b363 commented Aug 1, 2024

Describe your changes
It has been suggested that for some model choice situations, it would be helpful to run kmeans training from the command line, similarly to how naive bayes training can work. This PR adds kmeans training to the command line interface file.

To test, reviewer can use something like the following from the command line:
plantcv-train kmeans -i IMGDIR -k 3 -o OUTDIR/kmeans_cli_out.fit -r kmeans_train -p 2
with "IMGDIR" containing the four training images currently in testdata/kmeans_train_dir

Type of update

  • New feature or feature enhancement

For the reviewer
See this page for instructions on how to review the pull request.

  • PR functionality reviewed in a Jupyter Notebook
  • All tests pass
  • Test coverage remains 100%
  • Documentation tested
  • New documentation pages added to plantcv/mkdocs.yml
  • Changes to function input/output signatures added to updating.md
  • Code reviewed
  • PR approved

@k034b363 k034b363 added enhancement Enhancements to existing features work in progress Mark work in progress labels Aug 1, 2024
@k034b363 k034b363 added this to the PlantCV v4.x milestone Aug 1, 2024
Copy link

deepsource-io bot commented Aug 1, 2024

Here's the code health analysis summary for commits 279f12e..b20d164. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Python LogoPython✅ SuccessView Check ↗
DeepSource Test coverage LogoTest coverage✅ SuccessView Check ↗

Code Coverage Report

MetricAggregatePython
Branch Coverage100%100%
Composite Coverage100%100%
Line Coverage100%100%
New Branch Coverage100%100%
New Composite Coverage100%100%
New Line Coverage100%, ✅ Above Threshold100%, ✅ Above Threshold

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

@k034b363 k034b363 added the help wanted Request help label Aug 5, 2024
@k034b363 k034b363 removed the help wanted Request help label Aug 5, 2024
@k034b363
Copy link
Contributor Author

k034b363 commented Aug 5, 2024

I think I'm not going to add the command line option to the kmeans tutorial for now. I think that it maybe belongs in a separate tutorial about model choice more generally?

@k034b363 k034b363 added ready to review and removed work in progress Mark work in progress labels Aug 6, 2024
@k034b363 k034b363 requested a review from HaleySchuhl August 6, 2024 18:07
@annacasto annacasto self-requested a review August 16, 2024 15:31
@nfahlgren nfahlgren merged commit f0e9d0d into main Aug 16, 2024
5 checks passed
@nfahlgren nfahlgren deleted the add-kmeans-cli branch August 16, 2024 22:12
@nfahlgren nfahlgren modified the milestones: PlantCV v4.x, PlantCV v4.4 Aug 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancements to existing features ready to review
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants