Skip to main content

A set of tools for working with DeepRacer training

Project description

Deepracer Utilities - Analyzing Your DeepRacer Model

This is a set of utilities that will take your DeepRacer experience to the next level by allowing you to analyze your model, step by step, episode by episode. Only through analyzing what your model does will you be able to write the right reward function, choose the right action space and to tune the hyperparameters!

Installation

You can install the latest version of deepracer-utils via pip through

pip install deepracer-utils

Otherwise you can build your own version with

python3 setup.py build
python3 setup.py install

AWS CLI and boto3 extension

This package contains an extension to the AWS CLI and Boto3 that allows you to interact with the Deepracer Console through commands starting with aws deepracer. For details run

aws deepracer help

Then run this to install:

python -m deepracer install-cli

To remove deepracer support from aws-cli and boto3, run:

python -m deepracer remove-cli

About the Utilities

The best reference on how to use the utilities can be found in the deepracer-analysis Jupyter notebooks.

An overview of the different modules provided, and the key classes involved:

Module Class Description
deepracer.logs DeepRacerLog Class that is pointed to a Deepracer Model folder, locally or in an S3 bucket, and that reads in and processes trace files from simtrace or robomaker log files.
deepracer.logs AnalysisUtils Class that processes the raw log input and summarizes by episode.
deepracer.logs PlottingUtils Class that visualises the track and plots each step in an episode.
deepracer.logs TrainingMetrics Class that reads in Metrics data and provides data similar to the training graph in the Console.
deepracer.console ConsoleHelper Class that reads out logfiles directly from the console, and together with e.g. TrainingMetrics can be used to visualize training progress in real time.
deepracer.tracks TrackIO Class that processes track routes (.npy files) and displays waypoints graphically.
deepracer.model n/a Methods to run inference on individual images and to perform visual analysis.

Other information

License

This project retains the license of the aws-deepracer-workshops project which has been forked for the initial Community contributions. Our understanding is that it is a license more permissive than the MIT license and allows for removing of the copyright headers. We have decided to preserve the headers and only add copyright notice for the Community.

Standards and good practices, contributing

While doing our best to make deepracer-utils an outcome of best practices and standards, we are using what we learn, as we learn. If you see a solution that would be better to apply, if you see something that is a risk, do raise it with the Community. Thank you.

We are open to merge requests. Please open an issue first to agree on the outcomes of your work.

Contact

You can contact Tomasz Ptak through the Community Slack: http://join.deepracing.io

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

deepracer-utils-1.0.6rc0.tar.gz (8.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

deepracer_utils-1.0.6rc0-py3-none-any.whl (55.3 kB view details)

Uploaded Python 3

File details

Details for the file deepracer-utils-1.0.6rc0.tar.gz.

File metadata

  • Download URL: deepracer-utils-1.0.6rc0.tar.gz
  • Upload date:
  • Size: 8.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for deepracer-utils-1.0.6rc0.tar.gz
Algorithm Hash digest
SHA256 40492b25764af050732f47e8f624fc2f397a8bdb97eec87f10c22babcef14263
MD5 f09e41da0bd07dc6adb3045433e3e651
BLAKE2b-256 74011117a41209b295893f2c65b11030e0683ab5426f4dcca71f3dbade1648bb

See more details on using hashes here.

File details

Details for the file deepracer_utils-1.0.6rc0-py3-none-any.whl.

File metadata

File hashes

Hashes for deepracer_utils-1.0.6rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 433c6d909ba09626db9af7687f251c343e7802b58a46b4f1011f3b323cc0f0f0
MD5 378f35599e2f9efe5859ab8afd53987d
BLAKE2b-256 c10cf7500a3718cd6beb9e33d8a99eae42ea6f2c0a905564c961ce334e9d1143

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page