oneAPI-samples icon indicating copy to clipboard operation
oneAPI-samples copied to clipboard

Github repo and DevCloud better integration

Open krzeszew opened this issue 3 years ago • 5 comments

Existing Sample Changes

Description

The DevCloud uses a batch system for processing. To get the samples to run, users need to know how to create the script or know how to request an interactive mode.

To make it easier for DevCloud users to run the sample, I created scripts to build (build.sh) and run (run.sh) on DevCloud. Proper documentation explaining the process has been added to README.md.

In the hidden-markov-models example, there have been some major changes to the documentation. We decided to create separate scripts instead of explaining to users how to do it themselves. This makes it easier for the user to run the samples right after connecting to DevCloud using only one command and it improves the UX

This change will be later followed by others for the remaining samples

External Dependencies

List any external dependencies created as a result of this change.

Type of change

Please delete options that are not relevant. Add a 'X' to the one that is applicable.

  • [X] New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • [X] Command Line

krzeszew avatar Apr 05 '22 10:04 krzeszew

@bdmoore1 please take a look at the documentation change.

krzeszew avatar Apr 05 '22 10:04 krzeszew

@bdmoore1 The changes should not conflict with the VS Code extension. The scripts are send to the queue and run in batch mode. They immediately have a defined compute machine on which they will run due to the fact that it is necessary to use special commands to build and run the sample on a proper compute node such as fpga emulator. This is shown in the link you sent in section 2.1 (Build and run the sample in batch mode).

krzeszew avatar Apr 06 '22 12:04 krzeszew

@krzeszew I approve this PR, but I think you need a reviewer with administrator status to merge. You might need to add @praveenkk123 or someone else to this review.

bdmoore1 avatar Apr 06 '22 14:04 bdmoore1

@praveenkk123 could you please take a look?

krzeszew avatar Apr 25 '22 07:04 krzeszew

Updated commit to the current master and resolved readme files merge conflicts.

krzeszew avatar Aug 02 '22 10:08 krzeszew

Rebase on origin/master and resolve merging conflicts.

krzeszew avatar Aug 25 '22 15:08 krzeszew