-
Notifications
You must be signed in to change notification settings - Fork 3
Home
The proposed SDK was is targeted to make the design and development of HOBBIT-compatible components easier and to execute them locally without having a running HOBBIT-platform instance. More details about the HOBBIT platform and the HOBBIT project can be found here. The SDK helps platform users with the following tasks:
-
Design systems for benchmarking and debug them within a particular benchmark -
Design a benchmark and debug the interactions between its components -
Upload results (docker images of your components) to the online platform
Technically the SDK is focused on the orchestration of docker images/containers for all the required components. Basic implementations of hobbit-related components (described here) are also included into SDK to demonstrate how the local debugging process may be organized. As a result users may execute and debug their systems/benchmarks either “as is” (and hit the breakpoints in the code) or being packed into docker containers (the same manner as components will be operated by the online platform). The SDK provides users with internal log messages from the containers, which make the debugging process more effective and less error-prone.
-
Make sure that docker (version 17 and higher) is installed on your system (Otherwise install it by the following command:
sudo curl -sSL https://get.docker.com/ | sh” -
Clone the repository and install its artifacts to the local maven repository:
mnv install -DskipTests=true -
Include the following dependency into your pom-file:
<dependency><groupId>com.agtinternational.hobbit</groupId><artifactId>hobbit-java-sdk</artifactId><version>1.0</version></dependency>
The SDK provides a basis for tests creation for your HOBBIT-related components. You may just copy the contents of “ExampleBenchmarkTest.java” to your project and use it as a starting point. Replace the components in the pipeline by your own to debug your benchmark or benchmarking system. SDK offers developers to consequently pass these the following steps for their code: Test/Debug the components in non-dockerized mode Test/Debug the components in dockerized mode Upload images to the online platform
Feel free to ask your questions and suggestions under the Issues tab. Also feel free to put feedback about benchmarks and systems, for which SDK have been helpful.