Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Installation Instructions #760

Merged
merged 3 commits into from Jul 27, 2023
Merged

Conversation

ernestum
Copy link
Collaborator

@ernestum ernestum commented Jul 24, 2023

Description

Due to a bug in gym we need specific setuptools an pip version to install imitation. Also on M1 Macs we need a workaround to install grpio which also is a dependency of imitation.
This PR documents both of this in the installation instructions so people do not keep running into the same issues when installing imitation.

You find the rendered instructions here.

Testing

Documentation only changes.

@codecov
Copy link

codecov bot commented Jul 24, 2023

Codecov Report

Merging #760 (d7060c2) into master (2743c28) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #760   +/-   ##
=======================================
  Coverage   96.33%   96.33%           
=======================================
  Files          93       93           
  Lines        8789     8789           
=======================================
  Hits         8467     8467           
  Misses        322      322           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link

@RachelFreedman RachelFreedman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend changing "M1 macs" to "ARM64 macs" (so that people know it also applies to M2 macs, and future ones with the same architecture). Otherwise looks good to me!

@ernestum ernestum requested a review from Rocamonde July 26, 2023 11:13
@Rocamonde Rocamonde merged commit 19c7f35 into master Jul 27, 2023
15 checks passed
@Rocamonde Rocamonde deleted the installation_instructions branch July 27, 2023 17:22
WillZhangshiwei added a commit to WillZhangshiwei/imitation that referenced this pull request Jul 28, 2023
* Fix broken link in the experts documentation.

* Update installation instructions with workarounds for broken dependencies.

* Target all ARM64 macs not just M1 ones in the installation instructions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants