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

Add Docker Installation Documentation for M1 Mac (#4319) #4450

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

amanmogal
Copy link

@amanmogal amanmogal commented Feb 15, 2025

Description

This PR adds detailed Docker installation documentation for M1 Macs and links it in the README file, addressing issue #4319.

Changes

  • Added new docker_m1_setup.md file with comprehensive installation guide
  • Updated README.md with a link to the new documentation
  • Included troubleshooting steps and additional configuration options

Documentation Changes

Created docker_m1_setup.md with:

  • Prerequisites
  • Step-by-step installation process
  • Resource allocation guidelines
  • Common issues and solutions
  • Links to official documentation

Added Link in README

EvalAI/README.md
For Docker installation on M1 Mac, refer to the [Docker M1 Setup Guide](docker_m1_setup.md).

Testing Done

  • Verified documentation links are working
  • Confirmed installation steps are accurate for M1 Macs
  • Validated Markdown formatting

Related Issues

Fixes #4319

Additional Notes

Please review the documentation for clarity and completeness.

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.30%. Comparing base (96968d6) to head (8e025ce).
Report is 1113 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4450      +/-   ##
==========================================
- Coverage   72.93%   69.30%   -3.63%     
==========================================
  Files          83       20      -63     
  Lines        5368     3574    -1794     
==========================================
- Hits         3915     2477    -1438     
+ Misses       1453     1097     -356     

see 64 files with indirect coverage changes

see 64 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 39e2f2e...8e025ce. Read the comment docs.

@lazyperson1020
Copy link

@amanmogal how to fix #4425 ? Is it solved?

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.

add documentation on docker m1 setup
3 participants