Skip to content
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

MTN update readme #40

Open
wants to merge 51 commits into
base: main
Choose a base branch
from
Open

MTN update readme #40

wants to merge 51 commits into from

Conversation

MatDag
Copy link
Collaborator

@MatDag MatDag commented Feb 19, 2024

No description provided.

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
Copy link
Member

@tomMoral tomMoral left a comment

Choose a reason for hiding this comment

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

A first pass on the PR.

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
figures/plot_quadratics.py Outdated Show resolved Hide resolved
solvers/amigo.py Outdated Show resolved Hide resolved
Copy link
Member

@tomMoral tomMoral left a comment

Choose a reason for hiding this comment

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

A few more comment.
Overall for the template, remove all generic comments that are not relevant, and simplify the example. In their current form, it is too complex to parse I think

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
datasets/template_dataset.py Outdated Show resolved Hide resolved
datasets/template_dataset.py Outdated Show resolved Hide resolved
datasets/template_dataset.py Outdated Show resolved Hide resolved
datasets/template_dataset.py Outdated Show resolved Hide resolved
datasets/template_dataset.py Outdated Show resolved Hide resolved
Copy link
Member

@tomMoral tomMoral left a comment

Choose a reason for hiding this comment

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

I think you can further simplify. The goal is that someone who don't know jax should be able to add a problem so make this simple (maybe a problem with 2 scalar variables?)

datasets/template_dataset.py Outdated Show resolved Hide resolved
datasets/template_dataset.py Outdated Show resolved Hide resolved
datasets/template_dataset.py Outdated Show resolved Hide resolved
Copy link
Member

@tomMoral tomMoral left a comment

Choose a reason for hiding this comment

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

Some more comments.
I think for now it is still hard for someone that does not know the bench to add a new solver.

solvers/template_stochastic_solver.py Show resolved Hide resolved
solvers/template_stochastic_solver.py Show resolved Hide resolved
solvers/template_stochastic_solver.py Outdated Show resolved Hide resolved
solvers/template_stochastic_solver.py Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants