cnr-ibf-pa / hbp-bsp-issues

Ticketing system for developers/testers and power users of the Brain Simulation Platform of the Human Brain Project
4 stars 0 forks source link

Showcase: Validation #455

Closed alex4200 closed 4 years ago

alex4200 commented 4 years ago

Showcase Usecase

Aspect Detail
Summary Validation Use Case
Common document https://docs.google.com/document/d/1sIOLMhK-jYnSb4x-xDEewmNqQXd4sztfw8nrgYsbZYs/edit#
Usecase Group
Expert @apdavison
Scientific User
Deadline March 2020
HPC Requirements
Dependencies
Nominal runtime

Description

This use case is supposed to be a showcase use case to be shown to the reviewers at the end of SGA2 in May/June 2020. This section should contain a detailed description of what exactly to show to the reviewers (like a script):

Acceptance Criteria

Define here the acceptance tests to evaluate the use case’s compliance with the requirements as defined above. Also possible end users for testing can be included here.

Extra Requirements

System

Does this use case require any special system requirements (any special software package)? Does this use case require HPC access? If so, which ones? List detailed system requirements here.

Performance

What are additional performance requirements for this use case? What time should it take to run from start to end?

apdavison commented 4 years ago

This should be for the M24 milestone, shouldn't it?

alex4200 commented 4 years ago

@apdavison Yes you are correct - but to have the three Showcase items more visible I have them also in the September milestone (and they do not count in the weekly statistics).

alex4200 commented 4 years ago

@appukuttan-shailesh @apdavison Can you please add a somewhat detailed description/script to this issue of what you want to show to the reviewers? This information is still missing.

appukuttan-shailesh commented 4 years ago

Description

We intend to demonstrate the HippoUnit validation use case. HippoUnit is a test suite developed for the validation of electrophysiological responses of hippocampal single cell models. The tests simulate CA1 pyramidal cell models that mimic the electrophysiological protocol corresponding to that originally employed for obtaining the target experimental data. The behavior of the model is then evaluate quantitatively and compared to the target data using feature-based error scores. It currently comprises the following tests:

Acceptance Criteria

The Jupyter notebook should run to completion for the selected validations (see below: Steps to follow for demonstration). A scoring matrix and a validation report will be generated in the final few cells, which gives access to all available info on the validation results, and the underlying models and tests.

Extra Requirements

System

The following validation usecase specific Python packages are required for demonstration:

Performance

The first run of each validation (i.e. same test-model combination) can take on average 15 minutes for completion. Subsequent runs of the same validation, on the same machine with same user credentials, can be run with cached (default mode) data and thus would display the results faster. Therefore, for live demonstration purposes it would be advisable to run the desired the validation(s) beforehand, so as to allow live demo of the UseCase from start to end. Even with the usage of cached results, the validation would require around 5 minutes when all the tests are being run as only the raw data is cached, and all graphs and figures are re-created. Alternatively, we can launch the validations while live, and then show a previously completed validation result. (@sasaray would be the expert for help with caching feature).

Note

Improvements are being made on several components of the validation framework:

Steps to follow for demonstration:

Following are the input steps:

alex4200 commented 4 years ago

Details see now https://github.com/cnr-ibf-pa/hbp-bsp-issues/issues/514