Is running CompilerGym intended to leave cache directories behind?

❓ Questions and Help

Not sure if this is a bug or not, so submitting as a question. Running a CompilerGym experiment leaves behind many cache directories. When running a large experiment, this can create problems through the sheer number of directories in COMPILER_GYM_CACHE. I expected the COMPILER_GYM_CACHE to not have anything after the experiment exited cleanly.

Is there a way to avoid the experiments leaving the directories behind?

Steps to reproduce

Running the following on my machine leaves behind about 270 cache directories.

import compiler_gym
import compiler_gym.wrappers
from ray import tune
from ray.rllib.agents.ppo import PPOTrainer


def make_env(env_config):
    env = compiler_gym.make(env_config['cgym_id'])
    env = compiler_gym.wrappers.TimeLimit(env, env_config['timelimit'])
    dataset = env.datasets[env_config['dataset']]
    env = compiler_gym.wrappers.CycleOverBenchmarks(
        env, dataset.benchmarks())
    return env


config = {
    "env_config": {
        "cgym_id": "llvm-autophase-ic-v0",
        "timelimit": 45,
        "dataset": "benchmark://cbench-v1",
    },
    "env": "CompilerGym",
}

stop = {
    "timesteps_total": 10_000,
}

tune.register_env("CompilerGym", make_env)
tune.run(
    PPOTrainer,
    config=config,
    stop=stop,
    name='cgym_cache_dir_demo',
)

Environment

Please fill in this checklist:

• CompilerGym: 0.2.2
• How you installed CompilerGym (conda, pip, source): pip
• OS: Ubuntu 20.04.1 LTS (x86_64)
• Python version: 3.9.7
• Build command you used (if compiling from source): N/A
• GCC/clang version (if compiling from source): N/A
• Bazel version (if compiling from source): N/A
• Versions of any other relevant libraries: ray: 1.10.0, gym: 0.20.0

[ChrisCummins]

Thanks for reporting the issue @vuoristo, it was a fun bug to hunt 🙂

Cheers, Chris

[ChrisCummins]

Do you also know why this seems to differ between the systems?

That’s a good question. To be honest, I don’t know. In the logs you posted, it looks like the shutdown routine is running on your system, which leads me to believe it’s likely a race condition. This would also explain the randomness.

Cheers, Chris