Merge pull request #1832 from Kotlin/titanic-example

moving titanic example to examples/projects and enabling compiler plugin

Author: Jolanrensen

build-logic/src/main/kotlin/dfbuild.buildExampleProjects.gradle.kts

@@ -30,6 +30,7 @@ val versionsToSync =
         "kotlinDatetime",
         "log4j",
         "spark4",
+        "kotlin-dl",
     )
 
 val syncAllExampleFolders by tasks.registering {

examples/README.md

@@ -8,7 +8,7 @@
 * [android example](projects/android-example) A minimal Android project showcasing integration with Kotlin DataFrame.
 Also includes [Kotlin DataFrame Compiler Plugin](https://kotlin.github.io/dataframe/compiler-plugin.html).
 * [movies](projects/movies) Using extension properties [Access API](https://kotlin.github.io/dataframe/apilevels.html) to perform a data cleaning task
-* [titanic](idea-examples/titanic)
+* [titanic](projects/titanic)
 * [youtube](projects/youtube)
 * [json](idea-examples/json) Using OpenAPI support in DataFrame's Gradle and KSP plugins to access data from [API guru](https://apis.guru/) in a type-safe manner
 * [imdb sql database](https://github.com/zaleslaw/KotlinDataFrame-SQL-Examples) This project prominently showcases how to convert data from an SQL table to a Kotlin DataFrame 

examples/idea-examples/titanic/build.gradle.kts

@@ -0,0 +1,41 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+max_line_length = 120
+
+[*.json]
+indent_size = 2
+
+[{*.yaml,*.yml}]
+indent_size = 2
+
+[*.ipynb]
+insert_final_newline = false
+
+[*.{kt,kts}]
+ij_kotlin_code_style_defaults = KOTLIN_OFFICIAL
+
+#  Disable wildcard imports entirely
+ij_kotlin_name_count_to_use_star_import = 2147483647
+ij_kotlin_name_count_to_use_star_import_for_members = 2147483647
+ij_kotlin_packages_to_use_import_on_demand = unset
+
+ktlint_code_style = ktlint_official
+ktlint_experimental = enabled
+ktlint_standard_filename = disabled
+ktlint_standard_no-empty-first-line-in-class-body = disabled
+ktlint_class_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than = 4
+ktlint_function_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than = 4
+ktlint_standard_chain-method-continuation = disabled
+ktlint_ignore_back_ticked_identifier = true
+ktlint_standard_multiline-expression-wrapping = disabled
+ktlint_standard_when-entry-bracing = disabled
+ktlint_standard_expression-operand-wrapping = disabled
+
+[{*/build/**/*,**/*keywords*/**,**/*.Generated.kt,**/*$Extensions.kt,**/BuildConfig.kt}]
+ktlint = disabled

examples/projects/dev/titanic/.editorconfig

@@ -0,0 +1,16 @@
+# Titanic Example
+
+This is an example project for using DataFrame and [KotlinDL](https://github.com/Kotlin/kotlindl).
+(While said library has become slightly outdated,
+this example still showcases the power of DataFrame in combination with deep-learning techniques.)
+
+This project uses the
+[Kotlin DataFrame Compiler Plugin](https://kotlin.github.io/dataframe/compiler-plugin.html).
+
+We recommend using an up-to-date IntelliJ IDEA for the best experience,
+as well as the latest Kotlin plugin version.
+
+> [!WARNING]
+> For proper functionality in IntelliJ IDEA requires version 2025.2 or newer.
+
+[Download this Example](https://github.com/Kotlin/dataframe/raw/example-projects-archives/titanic.zip)

examples/projects/dev/titanic/README.md

@@ -0,0 +1,36 @@
+plugins {
+    alias(libs.plugins.kotlin.jvm)
+    alias(libs.plugins.kotlin.dataframe)
+    alias(libs.plugins.ktlint.gradle)
+
+    application
+}
+
+repositories {
+    mavenCentral()
+}
+
+application.mainClass = "org.jetbrains.kotlinx.dataframe.examples.titanic.ml.TitanicKt"
+
+dependencies {
+    // Add general `dataframe` dependency
+    implementation(libs.dataframe)
+
+    // note: needs to target java 11 for these dependencies
+    implementation(libs.kotlin.dl.api)
+    implementation(libs.kotlin.dl.impl)
+    implementation(libs.kotlin.dl.tensorflow)
+    implementation(libs.kotlin.dl.dataset)
+}
+
+tasks.test {
+    useJUnitPlatform()
+}
+kotlin {
+    jvmToolchain(11)
+}
+
+ktlint {
+    version = libs.versions.ktlint.asProvider()
+    // rules are set up through .editorconfig
+}

examples/projects/dev/titanic/build.gradle.kts

@@ -0,0 +1,5 @@
+org.gradle.jvmargs=-Xmx1g -Dfile.encoding=UTF-8
+kotlin.code.style=official
+# Disabling incremental compilation will no longer be necessary
+# when https://youtrack.jetbrains.com/issue/KT-66735 is resolved.
+kotlin.incremental=false

examples/projects/dev/titanic/gradle.properties

@@ -0,0 +1,21 @@
+[versions]
+kotlin = "2.3.21"
+dataframe = "1.0.0-Beta5"
+ktlint-gradle = "14.0.1"
+ktlint = "1.8.0"
+kotlin-dl = "0.5.2"
+
+[libraries]
+dataframe = { module = "org.jetbrains.kotlinx:dataframe", version.ref = "dataframe" }
+kotlin-dl-api = { module = "org.jetbrains.kotlinx:kotlin-deeplearning-api", version.ref = "kotlin-dl" }
+kotlin-dl-impl = { module = "org.jetbrains.kotlinx:kotlin-deeplearning-impl", version.ref = "kotlin-dl" }
+kotlin-dl-tensorflow = { module = "org.jetbrains.kotlinx:kotlin-deeplearning-tensorflow", version.ref = "kotlin-dl" }
+kotlin-dl-dataset = { module = "org.jetbrains.kotlinx:kotlin-deeplearning-dataset", version.ref = "kotlin-dl" }
+
+[plugins]
+kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
+ktlint-gradle = { id = "org.jlleitschuh.gradle.ktlint", version.ref = "ktlint-gradle" }
+
+
+# The Kotlin DataFrame Compiler plugin is the same version as the Kotlin plugin.
+kotlin-dataframe = { id = "org.jetbrains.kotlin.plugin.dataframe", version.ref = "kotlin" }

examples/projects/dev/titanic/gradle/libs.versions.toml

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.5.0-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists