https://github.com/paperspace/gradient-cli
The command line interface for Gradient - https://gradient.paperspace.com
https://github.com/paperspace/gradient-cli
ai deep-learning gradient machine-learning machine-learning-library paperspace python
Last synced: about 1 year ago
JSON representation
The command line interface for Gradient - https://gradient.paperspace.com
- Host: GitHub
- URL: https://github.com/paperspace/gradient-cli
- Owner: Paperspace
- License: isc
- Created: 2019-06-04T20:46:23.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T18:14:03.000Z (almost 2 years ago)
- Last Synced: 2025-03-31T10:06:51.995Z (about 1 year ago)
- Topics: ai, deep-learning, gradient, machine-learning, machine-learning-library, paperspace, python
- Language: Python
- Size: 3.49 MB
- Stars: 66
- Watchers: 13
- Forks: 22
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
----
> **Note**
> We are rolling out a new streamlined [Paperspace CLI](https://github.com/Paperspace/cli) and recommend using this new CLI for all new projects.
----
Gradient CLI
=================
[](https://pepy.tech/project/gradient)
**Get started:** [Create Account](https://console.paperspace.com/signup?gradient=true) • [Install CLI](https://docs.paperspace.com/gradient/cli/) • [Tutorials](https://docs.paperspace.com/gradient/tutorials/) • [Docs](https://docs.paperspace.com/gradient)
**Resources:** [Website](https://www.paperspace.com/) • [Blog](https://blog.paperspace.com/) • [Support](https://docs.paperspace.com/contact-support/) • [Contact Sales](https://paperspace.com/contact-sales)
Gradient is an an end-to-end MLOps platform that enables individuals and organizations to quickly develop, train, and deploy Deep Learning models. The Gradient software stack runs on any infrastructure e.g. AWS, GCP, on-premise and low-cost [Paperspace GPUs](https://docs.paperspace.com/gradient/machines/). Leverage automatic versioning, distributed training, built-in graphs & metrics, hyperparameter search, GradientCI, 1-click Jupyter Notebooks, our Python SDK, and more.
Key components:
* [Notebooks](https://www.paperspace.com/notebooks): 1-click Jupyter Notebooks.
* [Inference](https://www.paperspace.com/deployments): Deploy models as API endpoints.
Gradient supports any ML/DL framework (TensorFlow, PyTorch, XGBoost, etc).
See [releasenotes.md](https://github.com/Paperspace/gradient-cli/blob/master/releasenotes.md) for details on the current release, as well as release history.
Getting Started
===============
1. Make sure you have a Paperspace account set up. Go to [http://paperspace.com](https://console.paperspace.com/signup?gradient=true)
to register and generate an API key.
2. Use pip, pipenv, or conda to install the gradient package, e.g.:
`pip install -U gradient`
To install/update prerelease (Alpha/Beta) version version of gradient, use:
`pip install -U --pre gradient`
3. Set your api key by executing the following:
`gradient apiKey `
Note: your api key is cached in ~/.paperspace/config.json
You can remove your cached api key by executing:
`gradient logout`
Executing tasks on Gradient
=================
The Gradient CLI follows a standard [command] [--options] syntax
For example, to create a new Workflow in a project use:
```
gradient projects list
gradient workflows create --name --projectId
```
For a full list of available commands run `gradient workflows --help`. You can also view more info about Workflows in the [docs](https://docs.paperspace.com/gradient/explore-train-deploy/workflows).
Contributing
============
Want to contribute? Contact us at hello@paperspace.com
### Pre-Release Testing
Have a Paperspace QA tester install your change directly from the branch to test it.
They can do it with `pip install git+https://github.com/Paperspace/gradient-cli.git@MYBRANCH`.