LogoLogo
  • TABLE OF CONTENTS
  • General Concepts
    • Overview
    • Introduction to Rendered.ai
    • The Rendered.ai Platform
    • Who Uses Rendered.ai?
    • Rendered.ai Licensing and Offerings
  • Application User Guides
    • Overview
    • Quick Start Guide
      • Terminology
      • Content Codes
      • Getting Started with the SDK
    • Tutorials
      • Organization and Workspace Resources
      • Creating and Using Graphs
        • Graph Validation
        • Graph Best Practices
      • Creating and Using Datasets
        • Dataset Annotations
        • Dataset Analytics
        • Domain Adaptation
        • Dataset Comparison
        • Training and Inference
        • Mixing Datasets
        • Dataset Best Practices
      • Creating and Using Volumes
        • Inpaint Service
      • Collaboration
  • Development Guides
    • Overview
    • Ana Software Architecture
      • Basic components
      • Graphs
      • Channels
      • Packages
      • Package Volumes
      • Nodes
      • Schema
      • Ana Modules, Classes, and Functions
      • The anatools Package
      • Graph Validation
        • Typical Validation Use Cases
      • Preview
      • In-tool Help
    • Setting Up the Development Environment
      • Local Development With NVIDIA GPUs
      • Remote Development With AWS EC2
    • Deploying a Channel
    • An Example Channel - Toybox
      • Run and Deploy the Toybox Channel
      • Add a Modifier Node
      • Add a Generator Node
  • Open Source Channels
    • Toybox
    • DIRSIG Channel
  • Release Notes
    • Rendered.ai Platform
      • Platform Version 1.6.0
      • Platform Version 1.5.0
      • Platform Version 1.4.1
      • Platform Version 1.4.0
      • Platform Version 1.3.2
      • Platform Version 1.3.1
      • Platform Version 1.3.0
      • Platform Version 1.2.6
      • Platform Version 1.2.5
      • Platform Version 1.2.4
      • Platform Version 1.2.3
      • Platform Version 1.2.2
      • Platform Version 1.2.1
      • Platform Version 1.2.0
      • Platform Version 1.1.5
      • Platform Version 1.1.4
      • Platform Version 1.1.3
      • Platform Version 1.1.2
      • Platform Version 1.1.1
      • Platform Version 1.1.0
      • Platform Version 1.0.3
      • Platform Version 1.0.2
      • Platform Version 1.0.1
      • Platform Version 1.0.0
      • Platform Version 0.3.4.4
      • Platform Version 0.3.4.3
      • Platform Version 0.3.4.2
      • Platform Version 0.3.4.1
      • Platform Version 0.3.4
      • Platform Version 0.3.3.1
      • Platform Version 0.3.3
      • Platform Version 0.3.2.2
      • Platform Version 0.3.2.1
      • Platform Version 0.3.2
      • Platform Version 0.3.1.6
      • Platform Version 0.3.1.5
      • Platform Version 0.3.1.4
      • Platform Version 0.3.1.3
      • Platform Version 0.3.1.2
      • Platform Version 0.3.1
      • Platform Version 0.3.0.9
      • Platform Version 0.3.0.8
      • Platform Version 0.3.0.7
      • Platform Version 0.3.0.6
      • Platform Version 0.3.0.5
      • Platform Version 0.3.0
      • Platform Version 0.2.15
      • Platform Version 0.2.14
      • Platform Version 0.2.13
      • Platform Version 0.2.12
      • Platform Version 0.2.11
      • Platform Version 0.2.10
      • Platform Version 0.2.9
      • Platform Version 0.2.8
      • Platform Version 0.2.7
      • Platform Version 0.2.6
      • Platform Version 0.2.5
      • Platform Version 0.2.4
      • Platform Version 0.2.3
      • Platform Version 0.2.2
      • Platform Version 0.2.1
      • Platform Version 0.2.0
Powered by GitBook
On this page
  • Installing Docker
  • Installing VSCode and Extensions
  • Testing Dev Containers
  • Troubleshooting
Export as PDF
  1. Development Guides

Setting Up the Development Environment

PreviousIn-tool HelpNextLocal Development With NVIDIA GPUs

Last updated 7 months ago

Creating a custom channel for Rendered.ai is a Python-based development task. The channels are Docker containers and the development process is simplified by Rendered.ai maintained Development Containers that can be used with VSCode's Remote-Containers extension. This document will take you through installing Docker and the VSCode Remote-Containers extension so you can begin channel development on your local machine.

This process has been tested on several Linux distributions and Windows 11 with , there have been reported issues with M1 Macbooks with Docker – if you do have issues we recommend using for a better experience.

If you run into any issues or need additional help, email the Support team at .

Installing Docker

To install Docker for your local machine, follow the official installation instructions at .

After installing, we recommend running the hello-world test command to ensure Docker is running as expected. The following command will pull a test Docker image and print out hello world message.

docker run hello-world

Installing VSCode and Extensions

Extension Marketplace

To reach the Extension Marketplace, click the Extensions symbol on the left-hand side of the window.

Next we’ll install two extensions: Docker and Dev Containers. The Docker extensions can be helpful in seeing the Docker images and Docker containers that are currently running. The Dev Containers extension allows us to use the Docker container as a full-featured development environment from within VSCode – this helps ensure that the environment we are developing in is as close as possible to what gets deployed to the platform.

After we have the extensions installed, we are ready to pull the code and start our development.

Testing Dev Containers

Troubleshooting

Here we have compiled a list of common issues users may run into while configuring their development environment.

Docker not found

When starting the Development container in VSCode the following message may appear.

Start the Docker Desktop application.

Docker not found

When starting the Development container in VSCode the following message may appear.

Start the Docker Desktop application.

Allow your non-root user to execute docker

When starting the Development Container in VSCode the following message may appear.

This is due to VSCode having insufficient permissions to access the docker daemon on your behalf. You will need to ensure that the user has access to the docker daemon, on Linux operating systems you can add the current user to the docker group.

Important: Log out and log back in again to refresh group membership.

Failure to pull Public Image

When starting the Development Container in VSCode the following message may appear.

Add label

Visual Studio Code is free code editor that allows users to install extensions from an extension marketplace. The Rendered.ai Development Environment uses several extensions from the marketplace to simplify the developer experience. VSCode can be installed by following the official installation guide at .

We recommend following the tutorial to ensure your development environment is configured correctly. This will take you through cloning Rendered.ai’s Example channel, starting the Development Container then testing the execution of the channel.

sudo groupadd docker
sudo usermod -aG docker $USER
https://code.visualstudio.com/Download
Run and Deploy the Toybox Channel
WSL2
Remote Development with AWS EC2
support@rendered.ai
Install Docker Engine
Installing Docker
Installing VSCode and Extensions
Extension Marketplace
Testing Dev Containers
Troubleshooting
Successful Test of Docker Engine
Extensions Marketplace
Docker Extension
Dev Containers Extension