Package: devcloud
Intel® Devcloud - Developer Cloud for the Edge.Intel® Developer Cloud offers complimentary access to a wide range of Intel® architectures to help you get instant hands-on experience with Intel® software and execute your edge, AI, high-performance computing (HPC) and rendering workloads. With preinstalled Intel® optimized frameworks, tools, and libraries, you have everything you need to fast-track your learning and project prototyping.This library contains set of Python API which helps in deploying containerized application in the cloud and validate it against Intel's latest and greatest processorsSystem RequirementsBefore you start the installation, check the supported operating systems and required Python* versions. The complete list of supported hardware is available in theDevcloud Documentation.Supported Operating SystemPython* Version (64-bit)Ubuntu* 18.04 long-term support (LTS) x86, 64-bit3.7, 3.8, 3.9, 3.10Ubuntu* 20.04 long-term support (LTS) x86, 64-bit3.7, 3.8, 3.9, 3.10Red Hat* Enterprise Linux* 8 x86, 64-bit3.7, 3.8, 3.9, 3.10CentOS 7 x86, 64-bit3.7, 3.8, 3.9, 3.10macOS* 10.15 and higher versions, x86, 64-bit3.7, 3.8, 3.9, 3.10macOS* 11 and higher versions, arm643.7, 3.8, 3.9, 3.10Windows 10* and higher versions, x86, 64-bit3.7, 3.8, 3.9, 3.10NOTE: This package can be installed on other versions of Linux and Windows OSes, but only the specific versions above are fully validated.Install the Intel Devcloud Runtime PackageStep 1. Set Up Python Virtual EnvironmentUse a virtual environment to avoid dependency conflicts.To create a virtual environment, use the following commands:On Windows:python -m venv devcloud_envOn Linux and macOS:python3 -m venv devcloud_envNOTE: On Linux and macOS, you may need to install pip. For example, on Ubuntu execute the following command
to get pip installed:sudo apt install python3-venv python3-pip.Step 2. Activate Virtual EnvironmentOn Windows:devcloud_env\Scripts\activateOn Linux and macOS:source devcloud_env/bin/activateStep 3. Set Up and Update PIP to the Highest VersionRun the command below:python -m pip install --upgrade pipStep 4. Install the PackageRun the command below:pip install devcloudStep 5. Verify that the Package Is InstalledRun the command below:python -c "from devcloud import Devcloud"If installation was successful, you will not see any error messages (no console output).TroubleshootingFor general troubleshooting steps and issues, seeFrequently Asked Questions of Devcloud. The following sections also provide explanations to several error messages.Errors with Installing via PIP for Users in ChinaUsers in China might encounter errors while downloading sources via PIP during Devcloud installation. To resolve the issues, try the following solution:Add the download source using the-iparameter with the Pythonpipcommand. For example:pip install devcloud -i https://mirrors.aliyun.com/pypi/simple/Use the--trusted-hostparameter if the URL above is http instead of https.List of APIMethodDescriptionParametersReturnDevcloud.connectValidates the token and gives the snapshot of Dashboard and Project deployed by the usertoken: str(Optional) API Token of the user, if not provided then will be promptedenv: str - Name of the environment, default is "CP" which connects to container playground and for user's of PRC region please use "PRC"NoneDevcloud.transferTransfers file from Cloud storage like AWS S3 to Devcloudregion: str - AWS bucket regionbucketName: str - Name of the bucketpath: str - file/folder path present relative to the bucket to be copied to devcloudaccessKey: str (Optional) - Access key of AWS S3 bucketsecretKey: str (Optional) - Secret key of AWS S3 bucketNoneDevcloud.availableHardwarePrints available hardware and their respective ID, Processor Name, Integrated GPU Name and Memory detailNoneNoneDevcloud.createContainerCreates container image and stores in the devcloudprojectName: str - Unique name of the projectcontainerName: str - Unique name of the containerurl: str - Container image URLNoneDevcloud.configureContainerConfigures the container with various option as mentioned in parametersprojectName: str - Name of the project under which container presentcontainerName: str - Name of the container which needs to configured (This should be assigned to the project name mentioned above)port: list[int] - Port number which must be exposed to external consumption. Port range must be above 1024label: list[str] - Label to be associated to the containerentryScript: str - Initial file which must be executed when container boots upoutput: str - Output mount folder, which can be later accessed using Devcloud file systemmountPoint: list[(str, str)] - To mount Devcloud file system to user's container. This is a tuple, were first one is for Devcloud file system path and second is mount point in container. Multiple such mount path can be assignedenvironment: str - environment variable to be passed to container. eg., -e token=XYZNoneDevcloud.launchLaunches the Project against the selected hardwardprojectName: str - Name of the project which should be lauchededgeNode: int - Intel's latest and greatest hardware to be used. Get the list by calling Devcloud.availableHardware()NoneDevcloud.getStatusDisplays launched project statusprojectName: str (Optional) If provided will show dashboard detail of the projectoutput: str (Optional) if value is wide then provided additional detail such as Performance and create timeNoneDevcloud.getFilesPreviewGets the response object of the requested file path in the Devcloud's filesystemprojectName: str - Name of the projectpath: str - Relative path from the project's output folderedgeNode: str (Optional) - Intel processor used, if not provided then latest completed container's in the specified project will be usedcreateTime: str (Optional) - If present then this timestamp is used to retrieve the files present under the given runtime of the container_io.BytesIOList of External Libraries usedNameVersionRequests2.28.2Pyjwt2.6.0Typer0.6.1Pandas1.5.0Tabulate0.9.0Pillow9.4.0importlib-resources5.4.0Copyright © 2021-2023 Intel Corporation