NeuroBench / neurobench

Benchmark harness and baseline results for the NeuroBench algorithm track.
https://neurobench.readthedocs.io
Apache License 2.0
53 stars 12 forks source link

_lazy_import preventing easy access to functions descriptions and arguments pre-filling #61

Closed Maxtimer97 closed 4 months ago

Maxtimer97 commented 1 year ago

https://github.com/NeuroBench/neurobench/blob/b2adcf91c4725b411c2dc631a38cb7009fa8f903/neurobench/utils.py#L3-L5

I have the impression the use of _lazy_import is limiting the features (on VSCode in my case) to visualize functions descriptions and pre-filling features. Is it indeed the case and then can we find a better solution?

ben9809 commented 8 months ago

The module's loading is postponed until the method or class it offers is actually used in the code by using _lazy_import. Due to this delayed loading, the contents of the module are not accessible during the static analysis stage, which takes place when the IDE examines the script prior to it being executed. Because this module hasn't been loaded and examined yet, the IDE is unable to offer features like autocomplete, syntax highlighting, or inline documentation for its components.

jasonlyik commented 4 months ago

Since we have the documentation/examples up now, I think it we don't have to worry about this