Skip to content

Add local install command to README#3902

Open
yushangdi wants to merge 1 commit into
mainfrom
sy_readme
Open

Add local install command to README#3902
yushangdi wants to merge 1 commit into
mainfrom
sy_readme

Conversation

@yushangdi

@yushangdi yushangdi commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

as title

The pip install -e . --no-deps actually installs torchtitan as a local importable package.

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Meta Open Source bot. label Jul 10, 2026
@yushangdi yushangdi requested a review from SherlockNoMad July 10, 2026 22:44
Comment thread README.md Outdated
cd torchtitan
pip install -r requirements.txt
pip install --pre torchdata --index-url https://download.pytorch.org/whl/nightly/cpu
pip install -e . --no-deps

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

curious why you'd need this?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we're trying to land some runtimes estimators for the graph trainer in https://github.com/meta-pytorch/torchinsights/tree/main. For some components, the estimator wants to import from torchtitan. Without install it as a pacakage locally, import from torchtitan doesn't work.

The estimator #3828 (note that though it's currently a torchtitan PR, the plan is to land in torchinsights instead).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw the other two sections Nightly builds and Stable releases both install torchtitan as a package. But the From Source doesn't, it only installs the dependencies.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw the other two sections Nightly builds and Stable releases both install torchtitan as a package. But the From Source doesn't, it only installs the dependencies.

That's right, because the source doesn't require torchtitan install to use.

we're trying to land some runtimes estimators for the graph trainer in https://github.com/meta-pytorch/torchinsights/tree/main.

If it's another repo which depends on torchtitan, then I agree it's better to install.

I vaguely remember there's some caveat installing it even with -e, but I'll stamp since it's only readme.

Comment thread README.md Outdated
cd torchtitan
pip install -r requirements.txt
pip install --pre torchdata --index-url https://download.pytorch.org/whl/nightly/cpu
pip install -e . --no-deps

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw the other two sections Nightly builds and Stable releases both install torchtitan as a package. But the From Source doesn't, it only installs the dependencies.

That's right, because the source doesn't require torchtitan install to use.

we're trying to land some runtimes estimators for the graph trainer in https://github.com/meta-pytorch/torchinsights/tree/main.

If it's another repo which depends on torchtitan, then I agree it's better to install.

I vaguely remember there's some caveat installing it even with -e, but I'll stamp since it's only readme.

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

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants