|
| 1 | + |
| 2 | +# SDK for Diffgram |
| 3 | + |
| 4 | +This is the SDK for [Diffgram](https://github.com/diffgram/diffgram) <br> and |
| 5 | +[Diffgram.com](https://diffgram.com/) <br> |
| 6 | + |
| 7 | +## SDK Install |
| 8 | + |
| 9 | +#### [Full Documentation](https://diffgram.readme.io/docs) |
| 10 | + |
| 11 | +### Quickstart Install SDK |
| 12 | +`pip install diffgram` |
| 13 | + |
| 14 | +On linux |
| 15 | +`pip3 install diffgram` |
| 16 | + |
| 17 | +[Credentials Guide](https://diffgram.readme.io/reference) <br> |
| 18 | +[Get Credentials from Diffgram.com](https://diffgram.com/) (or your Private Deploy) |
| 19 | + |
| 20 | +The starting point for most useful work is to get a project: |
| 21 | +``` |
| 22 | +from diffgram import Project |
| 23 | +
|
| 24 | +project = Project(host = "https://diffgram.com", |
| 25 | + project_string_id = "replace_with_project_string", |
| 26 | + client_id = "replace_with_client_id", |
| 27 | + client_secret = "replace_with_client_secret") |
| 28 | +``` |
| 29 | + |
| 30 | +Replace `host` with your URL for Open Core installs. |
| 31 | + |
| 32 | +* [Tasks Introduction](https://diffgram.readme.io/docs/tasks-introduction) |
| 33 | +* [Import Introduction](https://diffgram.readme.io/docs/importing-your-data) |
| 34 | +* [Updating Existing Instances](https://diffgram.readme.io/docs/importing-instances-walkthrough) |
| 35 | +* [Pre-Label Example Video](https://youtu.be/55Hofp1H7yM) |
| 36 | +* [Compatibility](https://diffgram.readme.io/docs/compatibility-will-diffgram-work-with-my-system) |
| 37 | + |
| 38 | + |
| 39 | +#### Beta |
| 40 | +Note the API/SDK is in beta and is undergoing rapid improvement. There may be breaking changes. |
| 41 | +Please see the [API docs](https://diffgram.readme.io/reference) for the latest canonical reference |
| 42 | +and be sure to upgrade to latest ie: `pip install diffgram --upgrade`. We will attempt to keep the SDK up to date with the API. |
| 43 | + |
| 44 | +[Help articles for Diffgram.com](https://diffgram.readme.io/) See below for some examples. |
| 45 | + |
| 46 | +Requires Python >=3.5 |
| 47 | + |
| 48 | +The default install through pip will install dependencies |
| 49 | +for local prediction (tensorflow opencv) as listed in `requirements.txt`. |
| 50 | +The only requirement needed for majority of functions is `requests`. |
| 51 | +If you are looking for a minimal size install and already have requests use |
| 52 | +the `--no-dependencies` flag ie `pip install diffgram --no-dependencies` |
| 53 | + |
0 commit comments