Content Draft: Homepage, Getting Started, Concepts #353
Conversation
…rehensive getting started with dependency details, and expanded concepts page with Monarch, Services, TorchStore, and RL workflows
meta-cla
bot
added
the
CLA Signed
docs/source/concepts.md
Outdated
| ```python | ||
| from monarch.actor import Actor, this_host | ||
|
|
||
| # Create a process mesh with 8 GPUs |
There was a problem hiding this comment.
this is potentially misleading. since gpus is merely the name of the axis, naming it gpus doesn't actually assign the mesh 8 gpus.
There was a problem hiding this comment.
@AlannaBurke I think we can change all "GPUs" here to "procs" to reduce confusion
| 4. **Read Tutorials**: Follow {doc}`tutorials` for step-by-step guides | ||
| 5. **API Documentation**: Explore {doc}`api` for detailed API reference | ||
|
|
||
| ## Getting Help |
There was a problem hiding this comment.
I think this could go to the Home page maybe? Or a separate page? Could be another horizontal bar item.
docs/source/getting_started.md
Outdated
| - Usually pre-installed on Linux systems | ||
| - Verify with: `git --version` | ||
|
|
||
| ## Understanding TorchForge's Dependencies |
There was a problem hiding this comment.
I feel like this whole section might be too much for the getting started. Maybe we move it to the concepts?
We could just have a short list of 4 main dependencies and add for more information, see
docs/source/concepts.md
Outdated
|
|
||
| This guide covers the fundamental concepts and architecture behind TorchForge, | ||
| helping you understand how the system works and how to effectively use its components. | ||
| This guide covers the fundamental concepts and architecture behind TorchForge, helping you understand how the system works and how to effectively use its components. |
There was a problem hiding this comment.
for the concepts section I feel like there is a lot of text but hard to understand what those things are and how they are connected. Maybe we move ## Understanding TorchForge's Dependencies here and then also add what's in the tutorials PR?
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
|
@svekars i think i incorprated all of your changes - i also split the concepts page into smaller pages since it was so long. Have another look? |
docs/source/faq.md
Outdated
| # FAQ | ||
|
|
||
| This FAQ covers common questions and issues encountered when using TorchForge. | ||
| ## Common Installation Issues |
There was a problem hiding this comment.
I think we agreed not to have FAQ section for now, so we can delete this -
There was a problem hiding this comment.
Do you think these troubleshooting faqs are valuable info? i was just trying to reduce the length of the other pages - should i put these back with the installation, or just leave it for now and we can add it back later if we want?
There was a problem hiding this comment.
I don't have a strong opinion on this - feel free to leave as is.
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
|
@allenwang28 @pbontrager - can you please review this |
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
4 participants
Updated to include information from blog post :
(https://docs.google.com/document/d/1tKPpLZ2ngCT7b_Mwl6oX77alw5Bc_h1m5pnTs1LDdho/edit?tab=t.ysj8o61oflwf) - maybe link this on the readme or in the docs when it's published?
and #300