Skip to content

Document usage of .torchxconfig #421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
kiukchung opened this issue Mar 12, 2022 · 1 comment
Closed

Document usage of .torchxconfig #421

kiukchung opened this issue Mar 12, 2022 · 1 comment
Milestone
0.1.2 release

Comments

@kiukchung
Copy link
Contributor

📚 Documentation

Link

Current .torchxconfig docs (https://pytorch.org/torchx/main/runner.config.html) explain how it works and its APIs but does not provide any practical guidance on what configs can be put into it and why its useful.

What does it currently say?

Nothing wrong with what it currently says.

What should it say?

Should add more practical user guide on what are the supported configs in .torchxconfig and under what circumstances it gets picked up with the torchx CLI. As well as:

  1. Examples
  2. Best Practices

Why?

Current .torchxconfig docs is useful to the programmer but not for the user.
@kiukchung kiukchung added this to the 0.1.2 release milestone Mar 12, 2022
@d4l3k
Copy link
Member

d4l3k commented Mar 28, 2022

Closed by #434

@d4l3k d4l3k closed this as completed Mar 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.1.2 release
Development

No branches or pull requests
2 participants
@d4l3k @kiukchung