chore: update stale link and outdated details in README#31
Open
chore: update stale link and outdated details in README#31
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README to replace an outdated link and refresh the instructions for creating a custom data generation method.
- Changed instructions on how to implement a custom data generation strategy.
- Updated the example file reference from "customized_generator.py" to "custom_method.py".
Comment on lines
+31
to
+33
| You can create your own version by simply implementing your own optimization method based on the ones found in quanti-gin itself. | ||
|
|
||
| A full example of this can be found in [examples/customized_generator.py](quanti_gin/examples/customized_generator.py). | ||
| A full example of this can be found in [examples/custom_method.py](quanti_gin/examples/custom_method.py). |
There was a problem hiding this comment.
[nitpick] Consider clarifying what is expected from the 'optimization method' implementation. Adding a brief description of the necessary steps or requirements can help avoid confusion for users.
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.
Resolves #30