Skip to content

[doc] add a note about unit-testing to CONTRIBUTING.md#3970

Merged
ver217 merged 1 commit intohpcaitech:mainfrom
Fridge003:doc/test-requirements
Jun 14, 2023
Merged

[doc] add a note about unit-testing to CONTRIBUTING.md#3970
ver217 merged 1 commit intohpcaitech:mainfrom
Fridge003:doc/test-requirements

Conversation

@Fridge003
Copy link
Copy Markdown
Contributor

📌 Checklist before creating the PR

  • I have created an issue for this PR for traceability
  • The title follows the standard format: [doc/gemini/tensor/...]: A concise description
  • 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 #3875

📝 What does this PR do?

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

As is discussed in the referred issue, if the version of python is too high (>=3.10) during establishing environment for unit testing, fbgemm-gpu==0.2.0 cannot be correctly downloaded.

截屏2023-06-12 14 15 52

So I'm adding a note in CONTRIBUTING.md to warn about this potential bug, so contributors can avoid wasting time on this requirement bug.

💥 Checklist before requesting a review

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

⭐️ Do you enjoy contributing to Colossal-AI?

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

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

Comment thread CONTRIBUTING.md Outdated
@Fridge003 Fridge003 force-pushed the doc/test-requirements branch from 7bc15f4 to 79375a4 Compare June 14, 2023 07:40
@Fridge003 Fridge003 force-pushed the doc/test-requirements branch from 79375a4 to 27354db Compare June 14, 2023 07:47
@ver217 ver217 added the documentation Improvements or additions to documentation label Jun 14, 2023
@ver217 ver217 merged commit e8ad3c8 into hpcaitech:main Jun 14, 2023
@Fridge003 Fridge003 deleted the doc/test-requirements branch June 14, 2023 08:42
ver217 pushed a commit to ver217/ColossalAI that referenced this pull request Jul 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG]: CUDA Version: 12.1 requirements-test.txt error

2 participants