Add OptiSim usage example to README#297
Closed
mohini-aggarwal wants to merge 2 commits into
Closed
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a minimal, reproducible README example demonstrating how to use the OptiSim distance-based subset selection method (select_from_cluster) on a synthetic dataset to help new users get started.
Changes:
- Add an “Example” section showing how to generate a small synthetic dataset with NumPy.
- Demonstrate initializing
OptiSimand callingselect_from_clusterto obtain a subset of indices. - Print selected indices and the resulting selection size.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Author
|
Thanks, I have updated the example to clarify reproducibility and that sample size is approximate due to convergence. |
This file contains hidden or 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
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.
Adds a simple OptiSim usage example to the README.