Quickstart

Let’s start by configuring and running our first project.

Index

• Requirements

• Step by Step

• Next Steps

Requirements

TVM works with Tutor for that reason the Tutor requirements are also the TVM requirements.

Basic Requirements:

• Software:

  • Docker: v24.0.5+ (with BuildKit 0.11+)

  • Docker Compose: v2.0.0+

• Hardware:

  • Minimum configuration: 4 GB RAM, 2 CPU, 8 GB disk space

  • Recommended configuration: 8 GB RAM, 4 CPU, 25 GB disk space

For more information, see the Tutor requirements.

Step by Step

1. Install the latest stable release of TVM.

   pip install git+https://github.com/eduNEXT/tvm.git
   

2. Verify the installation.

   tvm --version
   

3. Create a new project with TVM.

   tvm project init <project-name> <tutor-version>
   
   # For example:
   # tvm project init tvm-test v14.0.0
   

4. Open the project folder.

   cd <project-name>
   

5. Activate the project environment.

   source .tvm/bin/activate
   

6. Run your project.

   tutor local launch
   

Note

For Tutor versions <15, init a project with tutor local quickstart`

Next Steps

• To do more with TVM, check Tutorials or TVM Topic Guides.

• To know more about Tutor, check Tutor documentation.