PySR icon indicating copy to clipboard operation
PySR copied to clipboard

Update README.md

Open folivetti opened this issue 1 year ago • 4 comments

added a tips section to the README on how to set the hyper-parameters from a recent experience running PySR with multiple datasets. Feel free to make editions or reject the pull request if you think it is not appropriate for the README

folivetti avatar Dec 18 '24 20:12 folivetti

Maybe this should go on the tuning page instead? https://ai.damtp.cam.ac.uk/pysr/tuning/

MilesCranmer avatar Dec 18 '24 20:12 MilesCranmer

Maybe this should go on the tuning page instead? https://ai.damtp.cam.ac.uk/pysr/tuning/

I think it should be more appropriate there, yes. But let me suggest to highlight the existence of this page in the README :-D I went through the example and didn't notice the link

folivetti avatar Dec 18 '24 20:12 folivetti

It's linked in the last sentence of the Quickstart: https://github.com/MilesCranmer/PySR?tab=readme-ov-file#quickstart

There are also tips for tuning PySR on this page.

But I guess people miss this. How should it be made more prominent? Maybe a special "docs/tuning" badge at the top of the README or something?

MilesCranmer avatar Dec 18 '24 20:12 MilesCranmer

It's linked in the last sentence of the Quickstart: https://github.com/MilesCranmer/PySR?tab=readme-ov-file#quickstart

There are also tips for tuning PySR on this page.

But I guess people miss this. How should it be made more prominent? Maybe a special "docs/tuning" badge at the top of the README or something?

yes!!!

folivetti avatar Dec 18 '24 20:12 folivetti