Obtaining the AIDK
The GiPStech AIDK is built using Kotlin Multiplatform and is available in three distribution formats:
- Maven Repository for Kotlin Mobile Multiplatform (KMM) projects.
- Maven Repository for Android projects written in Kotlin or Java.
- Xcode Framework for native iOS projects written in Swift or Objective-C.
Kotlin Mobile Multiplatform
To include the AIDK in your Kotlin Mobile Multiplatform project, follow these steps:
1. Add the GiPStech Maven repository
Modify your settings.gradle.kts (or settings.gradle if using Groovy) to include the custom Maven repository:
dependencyResolutionManagement {
repositories {
google()
mavenCentral()
maven("https://repo.gipstech.com/maven") // <-- ADD THIS LINE
}
}
2. Add the dependency in the Kotlin Multiplatform module
Modify your build.gradle.kts file to include the dependency for the required platforms.
kotlin {
sourceSets {
commonMain.dependencies {
implementation("com.gipstech:aidk:1.1.2") // <-- ADD THIS LINE
}
}
}
3. Sync the project
Once the dependency is added, synchronize Gradle:
- In Android Studio: File -> Sync Project with Gradle Files
-
From the Command Line run:
./gradlew build
Android
Including the AIDK in an Android project is very similar to the process described in the previous paragraph. The only difference is in section 2, where you need to modify the build.gradle.kts file to explicitly add the dependency for the Android platform, as shown below:
dependencies {
implementation("com.gipstech:aidk-android:1.1.2") // <-- ADD THIS LINE
}
Xcode
To include the GiPStech AIDK in your iOS application, download and integrate the Xcode framework available at repo.gipstech.com/frameworks into your Xcode project.
For detailed guidance on incorporating third-party frameworks, please refer to the official Apple documentation
Dependencies
The AIDK uses ONNX Runtime Mobile as its inference engine. Therefore, ONNX Runtime Mobile must also be included in the iOS application through CocoaPods.
Add the following dependency to your Podfile:
pod 'onnxruntime-mobile-c', '1.29.0'
Then install or update the CocoaPods dependencies:
pod install
After installing the dependency, open the generated .xcworkspace file instead of the .xcodeproj file.