Skip to content

chore: update stale link and outdated details in README #31

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.

Sign up for GitHub

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

Open
nylser wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: update stale link and outdated details in README #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ If you want to learn about more parameters you can use help:
## Customize the data generator

quanti-gin is designed so it can be easily customized with your heuristics for data generation.
You can create your own version by simply subclassing the `quanti_gin.DataGenerator` class.
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).
Comment on lines +31 to +33
Copy link

Copilot AI May 2, 2025

Choose a reason for hiding this comment

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

[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.

Copilot uses AI. Check for mistakes.

You can run the example code by executing:

python -m quanti_gin.examples.customized_generator
python -m quanti_gin --custom-method quanti_gin/examples/custom_method.py

## Documentation and Visualization notebook

Expand Down