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

📑 Feature Request: Extensions for updated test script #1228

Open
kurysauce opened this issue Aug 15, 2024 · 5 comments
Open

📑 Feature Request: Extensions for updated test script #1228

kurysauce opened this issue Aug 15, 2024 · 5 comments
Labels
enhancement New feature or request on-hold Interesting issue that we deprioritize

Comments

@kurysauce
Copy link
Contributor

kurysauce commented Aug 15, 2024

Describe your feature request.

After developing the updated test.py command for Ersilia #1203 , I believe having a detailed report for model contributors and users would be helpful in debugging and understanding the models in context.

The testing report summary, along with including the metrics measured in the test.py command should also include the following (not an exhaustive list):

  • Inuputs that were tested, inputs that raised specific errors
  • Software Dependencies: List of all libraries and tools used, including versions
    • Espeically helpful if users want to run and download the models locally
    • Warnings if models don't work on certain operating systems (MacOS, Windows, etc...)
  • Performance Tests:
    • metrics such as speed, memory usage
  • Output checks, If errors are raised or ouputs are invalid, describe them in context:
    • Missing Values
    • Outliers
    • Formatting Errors
@kurysauce kurysauce added the enhancement New feature or request label Aug 15, 2024
@kurysauce
Copy link
Contributor Author

  • Support the method check_consistent_output with checking more Output Shape types (as mentioned on the Ersilia Model Template Book)
    • Current type check supported are Single,List. Needs support for Flexible List, Matrix, Serializable Object
    • From a meeting with @miquelduranfrigola , we need to incorporate models that support this output shape type

@miquelduranfrigola
Copy link
Member

Thanks @kurysauce
@DhanshreeA to bring you up to speed, this is not something we need to tackle immediately but it is a nice feature request from @kurysauce . Let's leave it in out to-do list for now.

@kurysauce
Copy link
Contributor Author

Update check_consistent_output and comparison between bash & Ersilia run in run_bash methods to allow comparisons for data structure containing different output types. Current method only supports comparisons between outputs that are all numerical values and all strings.

@miquelduranfrigola
Copy link
Member

This makes sense. Thanks @kurysauce

@GemmaTuron GemmaTuron added the on-hold Interesting issue that we deprioritize label Sep 19, 2024
@GemmaTuron
Copy link
Member

Hi @DhanshreeA and @miquelduranfrigola

I am marking this as "on-hold" until we have a clear roadmap for Ersilia CLI commands

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request on-hold Interesting issue that we deprioritize
Projects
Status: On Hold
Development

No branches or pull requests

3 participants