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

Change the default of the enable_names option to false in the create_model function #937

Open
2 tasks
datejada opened this issue Nov 27, 2024 · 1 comment
Open
2 tasks
Labels
good first issue Good for newcomers

Comments

@datejada
Copy link
Member

Description

We create the model with names for debugging purposes. However, this can increase the model creation by 30% (see #936). So, it will be better to have this option as false by default, but we need to update the docs and provide an example to show users how to enable the names for debugging.

Actions:

  • Change the default value in the function
  • Create a how-to in the docs showing how to enable the names and the implications of the time creation
@clizbe
Copy link
Member

clizbe commented Dec 10, 2024

Stealing Jody's logic when discussing SpineOpt, I think it makes more sense to have enable_names = true as the default (but disable it in the tests) so that new users don't have to go digging to figure out what's happening. We can teach about disabling it for speed in our docs, and include it in the tutorials.

But open for discussion!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants