How to handle performance tests

[jgfouca]

Based on the discussion during the performance team meeting, notes here: https://acme-climate.atlassian.net/wiki/spaces/EP/pages/3922133143/2023-09-18+Performance+Infrastructure+Meeting+Notes

I am still not 100% sure on what our approach should be so I thought it might be helpful to list the features/behaviors that we want for performance tests:

1. In order to save testing time, it would be very nice if we could use some of the existing tests already being run as both "normal" and "performance" tests. This is tricky because, in order to get useful performance data, you have to turn off I/O, which then renders the test useless from the point-of-view of doing baseline comparisons. It would be nice if there were a setting to exclude I/O from performance metrics. This would allow a test to serve as both a performance test and a regular baseline test. @jayeshkrishna , is this possible?
2. If a test is known to be a performance test, CIME and scripts in $component/cime_config/* should automatically configure things for performance testing without requiring the user to make a lot of additional changes through test-mods etc. @amametjanov , it would be helpful if you could describe the things you need to change in order to get useful performance data.
3. In order to implement (2), the component will need to know the current case is a is a performance test. This should be easy if we assume SAVE_TIMING=ON implies performance test. I think the latest CIME (our submodule doesn't have this yet) we can at least rely on SAVE_TIMING being set to ON for performance tests.
4. CIME will need to mark tests with significant performance decreases as FAILs. I think we already have this via the TPUTCOMP test phase, but this CIME ticket https://github.com/ESMCI/cime/issues/2918 makes me think that maybe more functionality is needed. @billsacks , can you elaborate?
5. By default, our Jenkins python job code is set to ignore TPUTCOMP and MEMCOMP FAILs by default when reporting test statuses to cdash. The user can change this by adding --check-throughput --check-memory to the test script (in E3SM_test_scripts repo) but this is very easy to forget and it looks like almost no jobs are currently using these flags. Again, in the interest of making life easy for users, I think both these checks should be on by default for tests that have SAVE_TIMING on.
6. We want to be able to "bless" performance changes if we think a significant performance change in a test is acceptable. I think this is the one feature we fully understand and @wadeburgess and @jasonb5 already have most of what's needed here in place.

Feel free to edit to add features.

Related issues:

https://github.com/E3SM-Project/E3SM/issues/5885

[jgfouca]

Depending on the answer to 1. and 2. it may not be possible for a test to be both a baseline and performance test. If that's the case, then it raises the question of whether the new test-suite flag perf : True is adding any value and we should instead just use the PFS test type for all perf tests.

[billsacks]

4. CIME will need to mark tests with significant performance decreases as FAILs. I think we already have this via the TPUTCOMP test phase, but this CIME ticket PFS test should save timing output to the baseline directory ESMCI/cime#2918 makes me think that maybe more functionality is needed. @billsacks , can you elaborate?

At least in CESM, and at least last time I checked, the current TPUTCOMP is just based on the overall run times given in the model log files. This often isn't very useful for understanding differences in timings between runs. What I was referring to in https://github.com/ESMCI/cime/issues/2918 was saving the full contents of the timing directory (i.e., the detailed timing results that give min/max/etc. times spent in different blocks of code surrounded by timers). Is this possibly related to what you already do with SAVE_TIMING?

[jgfouca]

Thanks @billsacks , that does sound more useful than the TPUTCOMP check and possibly addresses point (1) above since it presumably would allow us to compare times that don't include I/O.

[rljacob]

Yes if we examine the timing output more closely, we can look at timers that don't include I/O.

Note that turning off I/O would also break any compareTwo test.

Currently, the fail condition is "time taken is outside tolerance from the last saved run". But if repeated PRs are just under the threshold, the model will gradually slow down and never fail a test. The threshold can't be to small because machine variability can lead to false negatives. So we need something outside of CIME that tracks performance trends over a few days or a a week.

Does the new capability in 6 require separate blesses for both performance fails AND baselines fails? When v3 went in, it slowed down the model and changed answers from baselines. The bless for the baselines also blessed the throughput change. In that case, we knew about the slowdown and were going to bless it but other baseline-change blesses could sneak in a performance degradation unless the performance slowdown is caught and requires its own bless.

[jgfouca]

@rljacob , that's a good point regarding (6). The clear intent from my meetings with @sarats is that we want to keep hist and performance baselines conceptually separate.

[jgfouca]

@jasonb5 , see above. This may require a bit more work on bless_test_results than we initially thought. We may also want to take a look at system_tests_common.py and the timing output to see if there are more useful comparisons that can be implemented.

[rljacob]

I still think we need a nightly test to see if there's a slowdown above the threshold and then separate bless for that. But we'll need another monitoring system watching for a gradual slowdown over days, weeks. Maybe that was part of the original PACE place. @sarats ?

[sarats]

@rljacob Yes, long-term longitudinal tracking was previously done using the E3SM Standardized performance benchmarks and now with proper PFS_* tests along with PACE would facilitate a better process.

Distracted by a conference and trying to catch up on what the remaining questions are to get the initial system in place.

[jasonb5]

I have the CIME baseline update started (https://github.com/ESMCI/cime/pull/4491). Right now it is still parsing and storing throughput and memory usage from the coupler log. With --save-timing we have access to the SYPD for each component.

The code for generating the performance baselines lives in CIME's repo right now, I can also update the design so that the code can live with the coupler. This way each coupler/model can define their own methods of generating/comparing performance metrics.

[jgfouca]

@jasonb5 , nice!

[sarats]

The component high-level timers that are used to compute throughput would include certain amount of I/O as well if I/O isn't turned off.

Regarding fine-grain timers: We parse and capture these within PACE. However, there isn't sufficient consistency or patterns across components that would make capturing relevant "performance" from a baseline run straight forward.

As it stands, we have to just use PFS and baseline tests separately to start with until we have a clear definition of every component's run loop timer without I/O.

[rljacob]

There must be something in model_timing_stats we could look at.

[sarats]

@jasonb5 Curious about the status of your CIME updates.

[jasonb5]

@sarats Just finishing up testing on the CIME side, I want to ensure we have good unit test coverage before it's merged and we do a CIME update. Should be merged by the end of this week.

[sarats]

Thanks @jasonb5 for getting https://github.com/ESMCI/cime/pull/4491 done.

Looks like we should be set to start performance tests now.

[jgfouca]

@sarats , I need to do a CIME update to bring this changes into E3SM. I will start one now.

[sarats]

I presume this (https://github.com/E3SM-Project/E3SM/pull/6000) got what we need.

We should go ahead and start regular perf tests.

[jasonb5]

@sarats There's another fix for bless_test_results on the way https://github.com/ESMCI/cime/pull/4502, this only affects blessing results, generating and comparing work.

[sarats]

*generating: Does that impact creation of the perf baselines? If so, can we get that in quickly?

[jasonb5]

@sarats That PR doesn't impact creation or comparison of perf baselines.

[amametjanov]

@jasonb5 If there are no cpl-[tput,mem].log files, new ones should be generated by bless_test_results.

> ./cime/CIME/Tools/bless_test_results -r /pscratch/sd/e/e3smtest/e3sm_scratch/pm-cpu/J -t JNextBench_lores20231025
Matched test batch is JNextBench_lores20231025_095608
###############################################################################
Blessing results for test: PFS_P5400.ne30pg2_EC30to60E2r2.F2010.pm-cpu_intel.eam-bench-noio, most recent result: PASS
Case dir: /pscratch/sd/e/e3smtest/e3sm_scratch/pm-cpu/J/PFS_P5400.ne30pg2_EC30to60E2r2.F2010.pm-cpu_intel.eam-bench-noio.C.JNextBench_lores20231025_095608
###############################################################################
Test 'PFS_P5400.ne30pg2_EC30to60E2r2.F2010.pm-cpu_intel.eam-bench-noio' had namelist diff
Update namelists (y/n)? y
Could not read throughput file: [Errno 2] No such file or directory: '/global/cfs/cdirs/e3sm/baselines/intel/master/PFS_P5400.ne30pg2_EC30to60E2r2.F2010.pm-cpu_intel.eam-bench-noio/cpl-tput.log'
Could not read memory usage file: [Errno 2] No such file or directory: '/global/cfs/cdirs/e3sm/baselines/intel/master/PFS_P5400.ne30pg2_EC30to60E2r2.F2010.pm-cpu_intel.eam-bench-noio/cpl-mem.log'

Also, please add the commit-hash to tput and mem logs.

[sarats]

@amametjanov and @jasonb5 Can you guys get together to iron out any other missing bits and minimize the iterations with the CIME PR, merge, E3SM upstream pull etc. Perhaps we can test some of this stuff locally/manually before issuing the final PRs.

[jasonb5]

@sarats @amametjanov I've fixed generating the performance baselines by bless_test_results when they don't exist, this is already in the CIME master branch. @amametjanov You can verify this using the master branch of CIME, I'll add the commit-hash to the tput and mem logs.

[jasonb5]

@amametjanov I've added the commit hash and date to the baseline files, you can use the branch from https://github.com/ESMCI/cime/pull/4508 to test.

[sarats]

@jgfouca I guess we need to do a final CIME update including https://github.com/ESMCI/cime/pull/4508 to close this, correct? We will keep the combined baseline+perf test idea on the radar.

[amametjanov]

We need a couple more updates:

1. add --ignore-history-diffs: so that perf-tests avoid failing on history diffs
2. archive timing to SAVE_TIMING_DIR: --save-timing isn't saving timing info.

[sarats]

@jasonb5 Will you be able to look into the above two tasks?

[jgfouca]

@amametjanov , @sarats , (1) is easy. I'm confused about (2). Is --save-timing just totally broken?

[amametjanov]

@jgfouca timing is getting archived into $RUNDIR/timing.$LID.tar.gz, but not getting copied to SAVE_TIMING_DIR.

[jgfouca]

@amametjanov , I did some debugging and it looks to me like it is working as intended:

JGF copying performance archive files to /sems-data-store/ACME/mappy/timings/performance_archive/jgfouca/ERS.f19_g16_rx1.A.mappy_gnu.20231108_093610_4nqyvk/1317334.231108-093723

+++ b/cime_config/customize/provenance.py
@@ -744,6 +744,7 @@ def _kill_mach_syslog(job_id, rundir):
 def _copy_performance_archive_files(
     case, lid, job_id, mach, rundir, caseroot, full_timing_dir, timing_saved_file
 ):
+    logger.info(f"JGF copying performance archive files to {full_timing_dir}")

I'm wondering if maybe you are getting tripped-up by the timing_dir gatekeeping code that checks the project:

            project = case.get_value("PROJECT", subgroup=case.get_primary_job())
            if not case.is_save_timing_dir_project(project):
            return

... so, only if PROJECT matches SAVE_TIMING_DIR_PROJECTS, which is a comma-separated list of regular expressions, will it copy the stuff to SAVE_TIMING_DIR.

[jasonb5]

@sarats @amametjanov @jgfouca Would it be better to bypass both history and namelists when blessing performance, keeping the two blessing paths completely separate?

[sarats]

I'm fine with a separate and distinct pathway for performance blesses bypassing history and namelists.

[jasonb5]

@amametjanov CIME's master branch now has the fix to separate hist/nml and performance blessing.

[amametjanov]

(1) is easy. I'm confused about (2). Is --save-timing just totally broken?

(1): pending (2): this appears to be a PACE issue: provenance data isn't getting uploaded from PM-CPU (3): new issue: shared-exe share:True test-suites are running into case-setup error Could not create the cosp build directory: e.g. coupled tests in https://my.cdash.org/viewTest.php?&buildid=2440663