Skip to content

[doc] add deprecated warning on doc Basics section#3754

Merged
ver217 merged 12 commits intohpcaitech:mainfrom
Yanjia0:main
May 22, 2023
Merged

[doc] add deprecated warning on doc Basics section#3754
ver217 merged 12 commits intohpcaitech:mainfrom
Yanjia0:main

Conversation

@Yanjia0
Copy link
Copy Markdown
Collaborator

@Yanjia0 Yanjia0 commented May 17, 2023 •
edited by ver217
Loading

📌 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

📝 What does this PR do?

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

add deprecated warnings on Basic section markdown documents
add recommended pages for reader to access updated info (pages will be created later)

💥 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.

@ver217 ver217 changed the title [doc]add deprecated warning on doc Basics section [doc] add deprecated warning on doc Basics section May 17, 2023
@ver217 ver217 added the documentation Improvements or additions to documentation label May 17, 2023
@ver217 ver217 merged commit d9393b8 into hpcaitech:main May 22, 2023
FrankLeeeee pushed a commit that referenced this pull request May 24, 2023
@Yanjia0 @FrankLeeeee
[doc] add deprecated warning on doc Basics section (#3754)
e0174a7 
* Update colotensor_concept.md

* Update configure_parallelization.md

* Update define_your_config.md

* Update engine_trainer.md

* Update initialize_features.md

* Update model_checkpoint.md

* Update colotensor_concept.md

* Update configure_parallelization.md

* Update define_your_config.md

* Update engine_trainer.md

* Update initialize_features.md

* Update model_checkpoint.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@ver217 ver217 ver217 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Yanjia0 @ver217