Skip to content

Commit

Permalink
Merge pull request #147 from vsbogd/fix-sdk-page
Browse files Browse the repository at this point in the history
Add information about Java SDK along with other SDKs
  • Loading branch information
vsbogd authored Sep 28, 2020
2 parents cc8a87c + 6e5891b commit 038d0a9
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 14 deletions.
54 changes: 40 additions & 14 deletions docs/ai-consumers/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,27 +21,53 @@ micro_nav: true

SDK is a tool for AI customers to make calls to services.

The SDK simplifies the process of integrating with SingularityNET services and provides tooling to automatically augment gRPC client stubs with the necessary authorisations.
The SDK simplifies the process of integrating with SingularityNET services and
provides tooling to automatically augment gRPC client stubs with the necessary
authorisations.

**Note**: SDK uses gRPC protocol for communication


We support SDK for the below three languages

- SDK in JAVA
- SDK in Python
- [SDK in JAVA](/tutorials/client/java/)
- [SDK in Python](/tutorials/sdk)
- SDK in NodeJS

All SDKs provided adhere to the same design standard and strategy

**Note**: According to the design pattern for the SDK modules such as functionality, need to be available in all programming languages, such as Java, Python and NodeJS.

The SDK can include several default funding strategies for payment channels, but allows and supports the developer to implement funding strategies for payment channel of their own, to control over tokens and service payments.

The SDK, in combination with the CLI, simplifies the process of fetching the latest service specification for dependent services, and compiles the proto definitions, so that the services can be invoked with minimal fuss.

Currently, a fully functional a [preliminary version of a Python SDK](https://github.com/singnet/snet-sdk-python) is available, which forms the basis for the [SDK tutorial](/tutorials/sdk), but has [some design improvements](https://github.com/singnet/snet-sdk-python/issues/16).

Work is in process towards an [SDK for Javascript](https://github.com/singnet/snet-sdk-js), and intend to support other popular languages and welcome third party contributions for people's favourite languages.

As these SDKs become stable the [SDK tutorial](/tutorials/sdk) will be periodically updated to to include details supporting each programming language.
**Note**: According to the design pattern for the SDK modules such as
functionality, need to be available in all programming languages, such as Java,
Python and NodeJS.

The SDK can include several default funding strategies for payment channels,
but allows and supports the developer to implement funding strategies for
payment channel of their own, to control over tokens and service payments.

The SDK, in combination with the CLI, simplifies the process of fetching the
latest service specification for dependent services, and compiles the proto
definitions, so that the services can be invoked with minimal fuss.

[Java SDK](https://github.com/singnet/snet-sdk-java) is ready for usage on Java
SE and Android platforms. Source code can be found at [GitHub
repo](https://github.com/singnet/snet-sdk-java) and artifacts are published at
[Jitpack repo](https://jitpack.io/#singnet/snet-sdk-java). [Java
tutorial](/tutorials/client/java/) is available on
SingularityNET dev portal. Preliminary version of [Android related
notes](https://github.com/singnet/snet-sdk-java/tree/master/plugin/gradle) and
[code examples](https://github.com/singnet/snet-sdk-java/tree/master/example)
are available at GitHub.

Currently, a fully functional a [preliminary version of a Python
SDK](https://github.com/singnet/snet-sdk-python) is available, which forms the
basis for the [SDK tutorial](/tutorials/sdk), but has [some design
improvements](https://github.com/singnet/snet-sdk-python/issues/16).

Work is in process towards an [SDK for
Javascript](https://github.com/singnet/snet-sdk-js), and intend to support
other popular languages and welcome third party contributions for people's
favourite languages.

As these SDKs become stable the [SDK tutorial](/tutorials/sdk) will be
periodically updated to to include details supporting each programming
language.
8 changes: 8 additions & 0 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,14 @@ bytools_cards:
right_url_name: Github
right_url_link: https://github.com/singnet/snet-cli

- title: Java SDK
img: 'http://placehold.jp/80x80.png'
description: Java SDK to invoke AI services on Java SE and Android
left_url_name: Download
left_url_link: https://jitpack.io/#singnet/snet-sdk-java
right_url_name: Github
right_url_link: https://github.com/singnet/snet-sdk-java

# Email Subscription Section
email_subscription:
title: Stay up to date
Expand Down
8 changes: 8 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ tools_cards:
right_url_name: Github
right_url_link: https://github.com/singnet/snet-cli

- title: Java SDK
img: 'http://placehold.jp/80x80.png'
description: Java SDK to invoke AI services on Java SE and Android
left_url_name: Download
left_url_link: https://jitpack.io/#singnet/snet-sdk-java
right_url_name: Github
right_url_link: https://github.com/singnet/snet-sdk-java

# Email Subscription Section
email_subscription:
title: Stay up to date
Expand Down

0 comments on commit 038d0a9

Please sign in to comment.