Skip to main content

A suite of flexible experiments of a variety of different tasks.

Project description

ExperimentLab

A suite of flexible experiments of a variety of different tasks.

Installation

To create a conda environment for this package use the following commands to do so

conda create -n experiment_lab python=3.11 -y
conda activate experiment_lab

Install the version of pytorch that is compatible with your hardware using the pip or conda command from their website.

To just install the experiment runner framework in one command:

pip install experiment-lab

or

pip install git+https://github.com/rishavb123/ExperimentLab.git

For specific optional dependencies use:

pip install -e "experiment-lab[{name}]"

where {name} can be all, ml, rl, rl-vid, or dev.

To test this installation, try this command (after logging into wandb with wandb login):

run_mc --config-name estimate_pi

which should run a monte carlo experiment to estimate the value of pi. See the experiments project in wandb to view the results of this experiment.

To install this package directly from the github reposity use the following commands:

git clone https://github.com/rishavb123/ExperimentLab.git
cd ExperimentLab
pip install -e .

As a test, try running the following script:

python experiment_lab/experiments/examples/random_waits.py n_runs=20 n_run_method=parallel seed=0

For specific optional dependencies use:

pip install -e ".[{name}]"

where {name} can be all, ml, rl, rl-vid, or dev.

Debugging Tips

Recording Videos on RL experiments

The video recording wrapper from the stable baselines library requires a few dependencies that must be installed before it can be used.

  1. Install moviepy to your python environment. This can be done using through this package via:
pip install "experiment_lab[rl-vid]"

or directly using,

pip install moviepy
  1. Install ffmpeg on your system using the following command (depending on your OS):
  • Ubuntu: sudo apt install ffmpeg
  • Mac: brew instlal ffmpeg
  • Windows: Follow the instructions here. Note that I did not write or review this instructions.
  1. Make sure to set the location of the ffmpeg binary to the `$IMAGEIO_F

Also, it should be noted that there are some issues with using the multiprocessing vector environment with the video recorder. Ensure that the start_method set in the RL config is "spawn" (which is the default if it is left as None) for best results. On MacOS, see this page for potential problems with using "fork".

Project details


Download files

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

Source Distribution

experiment_lab-1.1.8.tar.gz (27.9 kB view details)

Uploaded Source

Built Distribution

experiment_lab-1.1.8-py3-none-any.whl (40.8 kB view details)

Uploaded Python 3

File details

Details for the file experiment_lab-1.1.8.tar.gz.

File metadata

  • Download URL: experiment_lab-1.1.8.tar.gz
  • Upload date:
  • Size: 27.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for experiment_lab-1.1.8.tar.gz
Algorithm Hash digest
SHA256 c7aa7f91ebaff6fb0d14244f539ca9c324d0c155d0aaa8112ab8b9eb1b491c45
MD5 84e3c281c6f24527e7532e3b341a0cee
BLAKE2b-256 2d05bddc6e6171a4d55af6c84ef98cd900bd1c142ec30b6fc13bd7b2e7daab29

See more details on using hashes here.

File details

Details for the file experiment_lab-1.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for experiment_lab-1.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 4510e791da897ba5cec4b90c319088aaa9d7fa02c4c2643614907b26772e9880
MD5 4ebe204a370240773dff97ad59c560d7
BLAKE2b-256 2fa0d00c9063a62ccce55fd2d11d11853dee2e960d427a66ee503d75211b6119

See more details on using hashes here.

Supported by

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