Get Loop Unrolling Example Working out of Tree

[mostafaelhoushi]

Tried to copy and paste the example_loop_unrolling from the CompilerGym repo to a standalone repo, and get it to by just following 2 steps:

1. pip install compiler_gym
2. python example_unrolling_service/example_without_bazel.py

Here are some caveats/discussions:

• Maybe we should move this examples repo to facebookresearch GitHub account?
• Had to modify the code (see all the lines with FIXME) from the top-of-trunk in CompilerGym development branch to instead be compatible with the latest release of CompilerGym uploaded to PyPi
• To run clang commands, llvm.clang_path() didn't work so had to just use "clang" for now. But maybe that's OK as we expect people to use their own clang?
• As of now, when running the example, I am getting this error:

Traceback (most recent call last):
  File "example_unrolling_service/example_without_bazel.py", line 162, in <module>
    with compiler_gym.make(
  File "/Users/melhoushi/opt/anaconda3/envs/compiler_gym_examples/lib/python3.8/site-packages/compiler_gym/util/registration.py", line 16, in make
    return gym.make(id, **kwargs)
  File "/Users/melhoushi/opt/anaconda3/envs/compiler_gym_examples/lib/python3.8/site-packages/gym/envs/registration.py", line 200, in make
    return registry.make(id, **kwargs)
  File "/Users/melhoushi/opt/anaconda3/envs/compiler_gym_examples/lib/python3.8/site-packages/gym/envs/registration.py", line 105, in make
    env = spec.make(**kwargs)
  File "/Users/melhoushi/opt/anaconda3/envs/compiler_gym_examples/lib/python3.8/site-packages/gym/envs/registration.py", line 75, in make
    env = cls(**_kwargs)
  File "/Users/melhoushi/opt/anaconda3/envs/compiler_gym_examples/lib/python3.8/site-packages/compiler_gym/envs/compiler_env.py", line 287, in __init__
    self.benchmark = benchmark or next(self.datasets.benchmarks())
  File "/Users/melhoushi/opt/anaconda3/envs/compiler_gym_examples/lib/python3.8/site-packages/compiler_gym/envs/compiler_env.py", line 460, in benchmark
    benchmark_object = self.datasets.benchmark(benchmark)
  File "/Users/melhoushi/opt/anaconda3/envs/compiler_gym_examples/lib/python3.8/site-packages/compiler_gym/datasets/datasets.py", line 270, in benchmark
    return self.benchmark_from_parsed_uri(BenchmarkUri.from_string(uri))
  File "/Users/melhoushi/opt/anaconda3/envs/compiler_gym_examples/lib/python3.8/site-packages/compiler_gym/datasets/datasets.py", line 303, in benchmark_from_parsed_uri
    return dataset.benchmark_from_parsed_uri(uri)
  File "/Users/melhoushi/opt/anaconda3/envs/compiler_gym_examples/lib/python3.8/site-packages/compiler_gym/datasets/dataset.py", line 427, in benchmark_from_parsed_uri
    raise NotImplementedError("abstract class")
NotImplementedError: abstract class

Closes !facebookresearch/CompilerGym#532

[ChrisCummins]

• Maybe we should move this examples repo to facebookresearch GitHub account?

Yes. For now, let's make this repo private.

• Had to modify the code (see all the lines with FIXME) from the top-of-trunk in CompilerGym development branch to instead be compatible with the latest release of CompilerGym uploaded to PyPi

This is actually really useful as a canary for finding breaking changes 🙂

• To run clang commands, llvm.clang_path() didn't work so had to just use "clang" for now. But maybe that's OK as we expect people to use their own clang?

Odd. What was the error?

• As of now, when running the example, I am getting this error:

Comment left inline to fix that.

Cheers,
Chris

[ChrisCummins]

Thanks for bringing this one to my attention! I've added a workaround so that the old Reward.id won't break when we next push a release: facebookresearch/CompilerGym#612

[ChrisCummins]

Rename benchmark_from_parsed_uris to fix this

[mostafaelhoushi]

Thanks Chris. It fixed it, but then got another error down the line:

Traceback (most recent call last):
  File "example_unrolling_service/example_without_bazel.py", line 171, in <module>
    observation = env.reset()
  File "/Users/melhoushi/opt/anaconda3/envs/compiler_gym_examples/lib/python3.8/site-packages/compiler_gym/envs/compiler_env.py", line 812, in reset
    self._benchmark_in_use_proto.uri = str(self._benchmark_in_use.uri)
AttributeError: 'generator' object has no attribute 'uri'

[ChrisCummins]

Hit the wrong UI button and did this:

Not sure how to undo, sorry!

[mostafaelhoushi]

To run clang commands, llvm.clang_path() didn't work so had to just use "clang" for now. But maybe that's OK as we expect people to use their own clang?
Odd. What was the error?

Strange, when I reverted it to llvm.clang_path(), it works fine now :)

[mostafaelhoushi]

Hit the wrong UI button and did this: Not sure how to undo, sorry!

No worries... Me too I can't revert it :)