.. _torch_quick_start:

Get Started with PyTorch Neuron
===============================

This page provide links that will assist you to quickly start with :ref:`pytorch-neuronx-main` for both Inference and Training.



.. tab-set::

   .. tab-item:: Get Started with Training


        .. dropdown::  Launch Trn1 Instance
                :class-title: sphinx-design-class-title-small
                :class-body: sphinx-design-class-body-small
                :animate: fade-in

                .. include:: /general/setup/install-templates/launch-trn1.txt


        .. dropdown::  Install Drivers and Tools
                :class-title: sphinx-design-class-title-small
                :class-body: sphinx-design-class-body-small
                :animate: fade-in

                .. code:: bash


			# Configure Linux for Neuron repository updates

			sudo tee /etc/yum.repos.d/neuron.repo > /dev/null <<EOF
			[neuron]
			name=Neuron YUM Repository
			baseurl=https://yum.repos.neuron.amazonaws.com
			enabled=1
			metadata_expire=0
			EOF
			sudo rpm --import https://yum.repos.neuron.amazonaws.com/GPG-PUB-KEY-AMAZON-AWS-NEURON.PUB
			
			# Update OS packages
			sudo yum update -y

			# Install git
			sudo yum install git -y


			# Install OS headers
			sudo yum install kernel-devel-$(uname -r) kernel-headers-$(uname -r) -y

			# Remove preinstalled packages and Install Neuron Driver and Runtime
			sudo yum remove aws-neuron-dkms -y
			sudo yum remove aws-neuronx-dkms -y
			sudo yum remove aws-neuronx-oci-hook -y
			sudo yum remove aws-neuronx-runtime-lib -y
			sudo yum remove aws-neuronx-collectives -y
			sudo yum install aws-neuronx-dkms-2.*  -y
			sudo yum install aws-neuronx-oci-hook-2.*  -y
			sudo yum install aws-neuronx-runtime-lib-2.*  -y
			sudo yum install aws-neuronx-collectives-2.*  -y

			# Install EFA Driver(only required for multiinstance training)
			curl -O https://efa-installer.amazonaws.com/aws-efa-installer-latest.tar.gz
			wget https://efa-installer.amazonaws.com/aws-efa-installer.key && gpg --import aws-efa-installer.key
			cat aws-efa-installer.key | gpg --fingerprint
			wget https://efa-installer.amazonaws.com/aws-efa-installer-latest.tar.gz.sig && gpg --verify ./aws-efa-installer-latest.tar.gz.sig
			tar -xvf aws-efa-installer-latest.tar.gz
			cd aws-efa-installer && sudo bash efa_installer.sh --yes
			cd
			sudo rm -rf aws-efa-installer-latest.tar.gz aws-efa-installer

			# Remove pre-installed package and Install Neuron Tools
			sudo yum remove aws-neuron-tools  -y
			sudo yum remove aws-neuronx-tools  -y
			sudo yum install aws-neuronx-tools-2.*  -y

			export PATH=/opt/aws/neuron/bin:$PATH

        .. dropdown::  Install PyTorch Neuron (``torch-neuronx``)
                :class-title: sphinx-design-class-title-small
                :class-body: sphinx-design-class-body-small
                :animate: fade-in

                .. code:: bash

                        # Install Python venv and activate Python virtual environment to install
			# Neuron pip packages.
			python3.7 -m venv aws_neuron_venv_pytorch
			source aws_neuron_venv_pytorch/bin/activate
			pip install -U pip

			# Install packages from repos
			python -m pip config set global.extra-index-url "https://pip.repos.neuron.amazonaws.com"
		        
			# Install wget, awscli	
			pip install wget
			pip install awscli

			# Install Neuron packages
			pip install torch-neuronx==1.12.0.1.*
			pip install neuronx-cc==2.*


        .. dropdown::  Run Tutorial
                :class-title: sphinx-design-class-title-small
                :class-body: sphinx-design-class-body-small
                :animate: fade-in

                :ref:`neuronx-mlp-training-tutorial`       


        .. card:: Visit PyTorch Neuron section for more
                :class-body: sphinx-design-class-body-small
                :link: pytorch-neuronx-main
                :link-type: ref



   .. tab-item:: Get Started with Inference


        .. dropdown::  Launch Inf1 Instance
                :class-title: sphinx-design-class-title-small
                :class-body: sphinx-design-class-body-small
                :animate: fade-in

		.. include:: /general/setup/install-templates/launch-inf1.txt


        .. dropdown::  Install Drivers and Tools
                :class-title: sphinx-design-class-title-small
                :class-body: sphinx-design-class-body-small
                :animate: fade-in
		
                .. code:: bash
			
			# Configure Linux for Neuron repository updates
			sudo tee /etc/yum.repos.d/neuron.repo > /dev/null <<EOF
			[neuron]
			name=Neuron YUM Repository
			baseurl=https://yum.repos.neuron.amazonaws.com
			enabled=1
			metadata_expire=0
			EOF
			sudo rpm --import https://yum.repos.neuron.amazonaws.com/GPG-PUB-KEY-AMAZON-AWS-NEURON.PUB

			# Update OS packages
			sudo yum update -y
			
			################################################################################################################
                        # Remove older versions of Neuron
                        ################################################################################################################
			sudo yum remove aws-neuron-dkms -y
                        sudo yum remove aws-neuronx-dkms -y
                        sudo yum remove aws-neuron-tools -y
                        sudo yum remove aws-neuronx-tools -y

			################################################################################################################
			# To install or update to Neuron versions 2.5 and newer from previous releases:
			# - DO NOT skip 'aws-neuronx-dkms' install or upgrade step, you MUST install or upgrade to latest Neuron driver
			################################################################################################################

			# Install OS headers
			sudo yum install kernel-devel-$(uname -r) kernel-headers-$(uname -r) -y

			# Install Neuron Driver
			sudo yum install aws-neuronx-dkms -y

			####################################################################################
			# Warning: If Linux kernel is updated as a result of OS package update
			#          Neuron driver (aws-neuron-dkms) should be re-installed after reboot
			####################################################################################

			# Install Neuron Tools
			sudo yum install aws-neuronx-tools -y

			export PATH=/opt/aws/neuron/bin:$PATH

        .. dropdown::  Install PyTorch Neuron (``torch-neuron``)
                :class-title: sphinx-design-class-title-small
                :class-body: sphinx-design-class-body-small
                :animate: fade-in

  		.. code:: bash
			
			# Install Python venv and activate Python virtual environment to install    
			# Neuron pip packages.
			
			sudo yum install -y python3.7-venv gcc-c++
			python3.7 -m venv pytorch_venv
			source pytorch_venv/bin/activate
			pip install -U pip

			# Instal Jupyter notebook kernel 
			pip install ipykernel 
			python3.7 -m ipykernel install --user --name pytorch_venv --display-name "Python (Neuron PyTorch)"
			pip install jupyter notebook
			pip install environment_kernels

			# Set Pip repository  to point to the Neuron repository
			pip config set global.extra-index-url https://pip.repos.neuron.amazonaws.com

			#Install Neuron PyTorch
			pip install torch-neuron neuron-cc[tensorflow] "protobuf<4" torchvision


        .. dropdown::  Run Tutorial
                :class-title: sphinx-design-class-title-small
                :class-body: sphinx-design-class-body-small
                :animate: fade-in
		
		:ref:`ResNet-50 </src/examples/pytorch/resnet50.ipynb>`


        .. card:: Visit PyTorch Neuron section for more
                :class-body: sphinx-design-class-body-small
                :link: pytorch-neuronx-main
                :link-type: ref