240430.130223.HKT update README for the Python interface #1649
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Plot performance profiles for COBYLA, small | |
| on: | |
| # Trigger the workflow on push or pull request | |
| push: | |
| pull_request: # DANGEROUS! MUST be disabled for self-hosted runners! | |
| # Trigger the workflow by cron. The default time zone of GitHub Actions is UTC. | |
| # schedule: | |
| # - cron: '0 2,6,10,14,18,22 * * *' | |
| # Trigger the workflow manually | |
| workflow_dispatch: | |
| inputs: | |
| git-ref: | |
| description: Git Ref (Optional) | |
| required: false | |
| # Show the git ref in the workflow name if it is invoked manually. | |
| run-name: ${{ github.event_name == 'workflow_dispatch' && format('Manual run {0}', inputs.git-ref) || '' }} | |
| jobs: | |
| test: | |
| name: Profile PRIMA. | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest] | |
| matlab: [latest] | |
| dim: [small] | |
| solver: [cobylal, cobylan] | |
| competitor: [classical, archiva, norma] | |
| with_optim_toolbox: [yes, no] | |
| ctol_indicator: [0, 1, 2] | |
| exclude: | |
| - solver: cobylan | |
| with_optim_toolbox: yes | |
| steps: | |
| - name: Get the solver name | |
| run: echo "SOLNAME=$(echo ${{ matrix.solver }} | cut -c1-6)" >> $GITHUB_ENV | |
| - name: Clone Repository (Latest) | |
| uses: actions/checkout@v4 | |
| if: github.event.inputs.git-ref == '' | |
| with: | |
| fetch-depth: 2 # checkout fetches only one commit by default. Set it to two for the `norma` test | |
| ssh-key: ${{ secrets.SSH_PRIVATE_KEY_ACT }} # This forces checkout to use SSH, not HTTPS | |
| submodules: recursive | |
| - name: Clone Repository (Custom Ref) | |
| uses: actions/checkout@v4 | |
| if: github.event.inputs.git-ref != '' | |
| with: | |
| fetch-depth: 2 # checkout fetches only one commit by default. Set it to two for the `norma` test | |
| ref: ${{ github.event.inputs.git-ref }} | |
| ssh-key: ${{ secrets.SSH_PRIVATE_KEY_ACT }} # This forces checkout to use SSH, not HTTPS | |
| submodules: recursive | |
| - name: Set norma to the last commit to prepare for profiling | |
| if: ${{ matrix.competitor == 'norma' }} | |
| run: git checkout HEAD^ && cd .development && bash ./archnorma && cd ../ && git checkout - | |
| - name: Miscellaneous setup | |
| run: bash .github/scripts/misc_setup | |
| - name: Clone MatCUTEst | |
| uses: actions/checkout@v4 | |
| with: | |
| ssh-key: ${{ secrets.SSH_PRIVATE_KEY_ACT }} # This forces checkout to use SSH, not HTTPS | |
| repository: matcutest/matcutest_compiled | |
| path: matcutest | |
| - name: Link gfortran for MATLAB on Linux | |
| if: startsWith(matrix.os, 'ubuntu') | |
| run: bash .github/scripts/link_gfortran ${{ env.GFORTRAN_VERSION }} | |
| - name: Install epstopdf and ghostscript | |
| if: startsWith(matrix.os, 'ubuntu') | |
| run: bash .github/scripts/install_epstopdf && bash .github/scripts/install_ghostscript | |
| - name: Check MATLAB | |
| id: check_matlab | |
| run: if type 'matlab' &> /dev/null ; then echo "::set-output name=has_matlab::true" ; fi | |
| - name: Set up MATLAB with optimization toolbox | |
| if: ${{ steps.check_matlab.outputs.has_matlab != 'true' && matrix.with_optim_toolbox == 'yes' }} | |
| uses: matlab-actions/[email protected] | |
| with: | |
| release: ${{ matrix.matlab }} | |
| cache: true | |
| products: Optimization_Toolbox Parallel_Computing_Toolbox | |
| - name: Set up MATLAB without optimization toolbox | |
| if: ${{ steps.check_matlab.outputs.has_matlab != 'true' && matrix.with_optim_toolbox != 'yes' }} | |
| uses: matlab-actions/[email protected] | |
| with: | |
| release: ${{ matrix.matlab }} | |
| cache: true | |
| products: Parallel_Computing_Toolbox | |
| - name: Conduct the test | |
| uses: matlab-actions/[email protected] | |
| with: | |
| command: | | |
| ver; | |
| root_dir = pwd(); | |
| cd(fullfile(root_dir, 'matcutest')); install(); which macup | |
| cd(fullfile(root_dir, 'matlab/tests')); | |
| options = struct(); | |
| options.nr = 3; | |
| options.ctol_multiple = 10^(2*str2num('${{ matrix.ctol_indicator }}')); | |
| if strcmp('${{ matrix.solver }}', 'cobylal') | |
| prof('cobyla', '${{ matrix.dim }}', 'l', '${{ matrix.competitor }}', options); | |
| elseif strcmp('${{ matrix.solver }}', 'cobylan') | |
| prof('cobyla', '${{ matrix.dim }}', 'n', '${{ matrix.competitor }}', options); | |
| end | |
| % Move the files to prepare for uploading artifacts | |
| solver = 'cobyla'; | |
| cd(fullfile(cd(), 'testdata')); | |
| files = dir([solver, '*.summary.*.pdf']) | |
| for ifile = 1 : length(files) | |
| file = fullfile(files(ifile).folder, files(ifile).name) | |
| newfile = fullfile(files(ifile).folder, ['ctol', '${{ matrix.ctol_indicator }}_', '${{ matrix.with_optim_toolbox }}', '_optool_', files(ifile).name]) | |
| movefile(file, newfile); | |
| end | |
| movefile(fullfile(cd(), '*summary*.pdf'), '/tmp/cobyla_profile_prima/'); | |
| movefile(fullfile(cd(), '*.txt'), '/tmp/cobyla_profile_prima/'); | |
| files = [dir(['/tmp/', solver, '_profile_prima/*start*']); dir(['/tmp/', solver, '_profile_prima/*end*'])] | |
| for ifile = 1 : length(files) | |
| file = fullfile(files(ifile).folder, files(ifile).name) | |
| newfile = fullfile(files(ifile).folder, ['ctol', '${{ matrix.ctol_indicator }}_', '${{ matrix.with_optim_toolbox }}', '_optool_', files(ifile).name]) | |
| movefile(file, newfile); | |
| end | |
| - name: List problems that started but did not end | |
| # The solver got stuck when solving these problems. Investigate what happened. | |
| if: always() | |
| shell: bash | |
| run: | | |
| solver=${{ env.SOLNAME }} | |
| cd /tmp/${solver}_profile_prima/ | |
| ls -R1 *${solver}*_start > ${solver}_prob_start | |
| ls -R1 *${solver}*_end > ${solver}_prob_end | |
| diff ${solver}_prob_start ${solver}_prob_end > ${solver}_stuck || : | |
| printf "\n\n>>>>>>>>>>>>>>>>\nProblems that started but did not end:\n\n" | |
| cat ${solver}_stuck | |
| printf "\n<<<<<<<<<<<<<<<<\n\n" | |
| - name: Store artifacts | |
| uses: actions/[email protected] | |
| if: always() # Always run even if the workflow is canceled manually or due to overtime. | |
| with: | |
| name: artifact-${{ matrix.solver }}-${{ matrix.dim }}-${{ matrix.competitor }}-${{ matrix.with_optim_toolbox }}-${{ matrix.ctol_indicator }} | |
| path: | | |
| /tmp/cobyla_profile_prima/*summary*.pdf | |
| /tmp/cobyla_profile_prima/*.txt | |
| /tmp/cobyla_profile_prima/*start* | |
| /tmp/cobyla_profile_prima/*end* | |
| /tmp/cobyla_profile_prima/*stuck* | |
| /tmp/cobyla_profile_prima/fort.* | |
| - name: Remove the test data | |
| if: always() # Always run even if the workflow is canceled manually or due to overtime. | |
| run: rm -rf ./matlab/tests/testdata && rm -rf /tmp/cobyla_profile_prima | |
| merge_artifacts: | |
| continue-on-error: true # As of 20240218, this action may fail if there are too many artifacts. We ignore the failure. | |
| if: always() | |
| runs-on: ubuntu-latest | |
| needs: test | |
| steps: | |
| - name: Merge Artifacts | |
| uses: actions/upload-artifact/merge@v4 | |
| with: | |
| name: 00-merged-artifacts | |
| pattern: artifact-* |