Skip to content

Commit aaeee71

Browse files
d4l3kfacebook-github-bot
authored andcommitted
README + deps improvements (#59)
Summary: This updates the readme with missing sections as well as improves our deps handling to match. It also defines extras_require so you can install KFP dependencies via `pip install torchx[kfp]`. TorchX has amazingly few dependencies for the core launcher + dsl. Pull Request resolved: #59 Test Plan: ``` virtualenv /tmp/venv source /tmp/venv/bin/activate.fish pip install -e . torchx run --scheduler local utils.echo.get_app_spec --msg test pip install -e .[kfp] python examples/pipelines/kfp/kfp_pipeline.py --data_path /tmp/ --output_path /tmp/ --package_path /tmp/pipeline.yaml ``` Reviewed By: kiukchung Differential Revision: D29150834 Pulled By: d4l3k fbshipit-source-id: 364182b9e396df974d65ad2f87493cda0932e1a7
1 parent fafaf71 commit aaeee71

File tree

3 files changed

+13
-7
lines changed

3 files changed

+13
-7
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
# TorchX
55

66

7+
TorchX is a library containing standard DSLs for authoring and running PyTorch
8+
related components for an E2E production ML pipeline.
9+
710
For the latest documentation, please refer to our [website](https://pytorch.org/torchx).
811

912

@@ -18,19 +21,21 @@ TorchX Kubeflow Pipelines Support (torchx-kfp):
1821

1922
## Installation
2023
```bash
21-
# install torchx sdk
24+
# install torchx sdk and CLI
2225
pip install torchx
2326

2427
# install torchx kubeflow pipelines (kfp) support
25-
pip intall torchx-kfp
28+
pip intall torchx[kfp]
2629
```
2730

2831
## Quickstart
29-
<TODO PLACEHOLDER>
32+
33+
See the [quickstart guide](https://pytorch.org/torchx/latest/quickstart.html).
3034

3135
## Contributing
3236

3337
We welcome PRs! See the [CONTRIBUTING](CONTRIBUTING.md) file.
3438

3539
## License
40+
3641
TorchX is BSD licensed, as found in the [LICENSE](LICENSE) file.

requirements.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
1-
torch>=1.8.1
21
pyre-extensions
3-
# (optional) kfp==1.6.2
42
docstring-parser==0.8.1

setup.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ def get_version():
3333
reqs = f.read()
3434

3535
with open("dev-requirements.txt") as f:
36-
test_reqs = f.read()
36+
dev_reqs = f.read()
3737

3838
version = get_version()
3939
print("-- Building version: " + version)
@@ -52,7 +52,6 @@ def get_version():
5252
keywords=["pytorch", "machine learning"],
5353
python_requires=">=3.8",
5454
install_requires=reqs.strip().split("\n"),
55-
tests_requires=test_reqs.strip().split("\n"),
5655
include_package_data=True,
5756
packages=find_packages(exclude=("examples", "*.test", "aws*", "*.fb")),
5857
test_suite="torchx.test.suites.unittests",
@@ -61,6 +60,10 @@ def get_version():
6160
"torchx=torchx.cli.main:main",
6261
],
6362
},
63+
extras_require={
64+
"kfp": ["kfp==1.6.2"],
65+
"dev": dev_reqs,
66+
},
6467
# PyPI package information.
6568
classifiers=[
6669
"Development Status :: 4 - Beta",

0 commit comments

Comments
 (0)