Skip to content

AI Getting Started and Features and Functionality README Template

Jump to bottom Edit New page
ishaghosh27 edited this page Mar 6, 2024 · 4 revisions

Sample Title

Short description.

Property Description
Category Sample category
What you will learn How to start using ___
Time to complete __ minutes

Purpose

Prerequisites

Optimized for Description
OS
Hardware
Software

Note: AI and Analytics samples are validated on AI Tools Offline Installer. For the full list of validated platforms refer to Platform Validation.

Key Implementation Details

  • Entry 1

  • Entry 2

    Click to see more details.

    Extra details that may not be interesting to all of the users.

  • Entry N

Environment Setup

You will need to download and install the following toolkits, tools, and components to use the sample.

1. Get Intel® AI Tools

Required AI Tools: < >
If you have not already, select and install these Tools via AI Tools Selector. AI and Analytics samples are validated on AI Tools Offline Installer. It is recommended to select Offline Installer option in AI Tools Selector.

2. Install dependencies

pip install -r requirements.txt

Install Jupyter Notebook by running pip install notebook. Alternatively, see Installing Jupyter for detailed installation instructions.

Run the Sample

Note: Before running the sample, make sure Environment Setup is completed. Go to the section which corresponds to the installation method chosen in AI Tools Selector to see relevant instructions:

AI Tools Offline Installer (Validated)

  1. If you have not already done so, activate the AI Tools bundle base environment. If you used the default location to install AI Tools, open a terminal and type the following
source $HOME/intel/oneapi/intelpython/bin/activate

If you used a separate location, open a terminal and type the following

source <custom_path>/bin/activate
  1. Activate the Conda environment:
conda activate < >
  1. Clone the GitHub repository:
git clone https://github.com/oneapi-src/oneAPI-samples.git
cd oneapi-samples/AI-and-Analytics/< >
  1. Launch Jupyter Notebook:

Note: You might need to register Conda kernel to Jupyter Notebook kernel, feel free to check the instruction

jupyter notebook --ip=0.0.0.0
  1. Follow the instructions to open the URL with the token in your browser.
  2. Select the Notebook:
< >.ipynb
  1. Change the kernel to < >
  1. Run every cell in the Notebook in sequence.

Conda/PIP

Note: Make sure your Conda/Python environment with AI Tools installed is activated

  1. Clone the GitHub repository:
git clone https://github.com/oneapi-src/oneAPI-samples.git
cd oneapi-samples/AI-and-Analytics/< >
  1. Launch Jupyter Notebook:

Note: You might need to register Conda kernel to Jupyter Notebook kernel, feel free to check the instruction

jupyter notebook --ip=0.0.0.0
  1. Follow the instructions to open the URL with the token in your browser.
  2. Select the Notebook:
< >.ipynb
  1. Run every cell in the Notebook in sequence.

Docker

AI Tools Docker images already have Get Started samples pre-installed. Refer to Working with Preset Containers to learn how to run the docker and samples.

Example Output

Related Samples

License

Code samples are licensed under the MIT license. See License.txt for details.

Third party program Licenses can be found here: third-party-programs.txt

*Other names and brands may be claimed as the property of others. Trademarks

Additional Information on DPC++ topics can be found in the book(pdf):

Clone this wiki locally