ColossalAI icon indicating copy to clipboard operation
ColossalAI copied to clipboard
verified publisher icon hpcaitech

[doc] specified operating system requirement

Open FrankLeeeee opened this issue 2 years ago • 2 comments

📌 Checklist before creating the PR

  • [x] I have created an issue for this PR for traceability
  • [x] The title follows the standard format: [doc/gemini/tensor/...]: A concise description
  • [x] I have added relevant tags if possible for us to better distinguish different PRs

🚨 Issue number

Link this PR to your issue with words like fixed to automatically close the linked issue upon merge

e.g. fixed #1234, closed #1234, resolved #1234

Fixed #3018

📝 What does this PR do?

Summarize your work here. if you have any plots/diagrams/screenshots/tables, please attach them here.

This PR aims to make it clear that Windows is not supported yet to the user, some changes include:

  1. Added OS check in setup.py
  2. Added extra notes to README and documentation.

💥 Checklist before requesting a review

  • [x] I have linked my PR to an issue (instruction)
  • [x] My issue clearly describes the problem/feature/proposal, with diagrams/charts/table/code if possible
  • [x] I have performed a self-review of my code
  • [x] I have added thorough tests.
  • [x] I have added docstrings for all the functions/methods I implemented

⭐️ Do you enjoy contributing to Colossal-AI?

  • [x] 🌝 Yes, I do.
  • [ ] 🌚 No, I don't.

Tell us more if you don't enjoy contributing to Colossal-AI.

FrankLeeeee avatar Mar 06 '23 14:03 FrankLeeeee

Hi @FrankLeeeee I have added Linux support at the beginning. https://github.com/hpcaitech/ColossalAI#installation

binmakeswell avatar Mar 06 '23 15:03 binmakeswell

Hi @FrankLeeeee I have added Linux support at the beginning. https://github.com/hpcaitech/ColossalAI#installation

Ok, I will add it to docs as well.

FrankLeeeee avatar Mar 06 '23 15:03 FrankLeeeee

The code coverage for the changed files is %.

Click me to view the complete report 
Name       Stmts   Miss  Cover
------------------------------
setup.py      73     73     0%
------------------------------
TOTAL         73     73     0%

github-actions[bot] avatar Mar 07 '23 10:03 github-actions[bot]

what reasons is this not supported on Windows other than:

resource is a Unix specific package as seen in https://docs.python.org/2/library/resource.html which is why it worked for you in Ubuntu, but raised an error when trying to use it in Windows.

https://stackoverflow.com/questions/37710848/importerror-no-module-named-resource

unclemusclez avatar Jun 18 '24 23:06 unclemusclez