AI Getting Started and Features and Functionality README Template

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 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.

Note: If Docker option is chosen in AI Tools Selector, refer to Working with Preset Containers to learn how to run the docker and samples.

2. (Offline Installer) Activate the AI Tools bundle base environment

If the default path is used during the installation of AI Tools:

source $HOME/intel/oneapi/intelpython/bin/activate

If a non-default path is used:

source <custom_path>/bin/activate

3. (Offline Installer) Activate relevant Conda environment

conda activate <offline-conda-env-name>  

4. Clone the GitHub repository

git clone <link-to-the-repo>.git
cd <path-to-sample-dir>

5. Install dependencies

Note: Before running the following commands, make sure your Conda/Python environment with AI Tools installed is activated

pip install -r requirements.txt
pip install notebook

For Jupyter Notebook, refer to 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)
• Conda/PIP
• Docker

AI Tools Offline Installer (Validated)

1. Register Conda kernel to Jupyter Notebook kernel

If the default path is used during the installation of AI Tools:

$HOME/intel/oneapi/intelpython/envs/<offline-conda-env-name>/bin/python -m ipykernel install --user --name=<offline-conda-env-name>

If a non-default path is used:

<custom_path>/bin/python -m ipykernel install --user --name=<offline-conda-env-name>

2. Launch Jupyter Notebook

jupyter notebook --ip=0.0.0.0

3. Follow the instructions to open the URL with the token in your browser

4. Select the Notebook

<sample-file-name>.ipynb

5. Change the kernel to <offline-conda-env-name>

6. Run every cell in the Notebook in sequence

Conda/PIP

Note: Before running the instructions below, make sure your Conda/Python environment with AI Tools installed is activated

1. Register Conda/Python kernel to Jupyter Notebook kernel

For Conda:

<CONDA_PATH_TO_ENV>/bin/python -m ipykernel install --user --name=<your-env-name>

To know <CONDA_PATH_TO_ENV>, run conda env list and find your Conda environment path.

For PIP:

python -m ipykernel install --user --name=<your-env-name>

2. Launch Jupyter Notebook

jupyter notebook --ip=0.0.0.0

3. Follow the instructions to open the URL with the token in your browser

4. Select the Notebook

<sample-file-name>.ipynb

5. Change the kernel to <your-env-name>

6. 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

• sample 1
• sample 2

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