Skip to content

Commit 50b9530

Browse files
committed
Add documentation for Kotlin Notebook Plugin usage and troubleshooting
This update introduces new documentation sections covering the usage of the Kotlin Notebook Plugin and a troubleshooting guide.
1 parent b5073de commit 50b9530

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

docs/StardustDocs/d.tree

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,5 +186,8 @@
186186
</toc-element>
187187
</toc-element>
188188
<toc-element topic="gradleReference.md"/>
189+
<toc-element topic="Usage-with-Kotlin-Notebook-Plugin.md">
190+
<toc-element topic="Trobleshooting.md"/>
191+
</toc-element>
189192
<toc-element href="https://github.com/Kotlin/dataframe/tree/master/examples" toc-title="Examples"/>
190193
</instance-profile>
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Troubleshooting
2+
3+
## Freezing when working with large page sizes
4+
5+
Some operations in the UI may lag or freeze noticeably when working with large page sizes. Examples of these operations include sorting using the column header or navigating to the next page. This occurs because the UI attempts to render all the data at once, leading to excessive allocations and garbage collection (GC) pressure.
6+
7+
To mitigate this issue, try the following:
8+
- Reduce the page size to a smaller value.
9+
- Increase the JVM heap size in the Kotlin Notebook Plugin settings.
10+
- Tune the JVM GC settings of IntelliJ IDEA.
11+
- For example, adjust the `G1ReservePercent` parameter.
12+
- Further tuning is possible. For more detailed guidance, refer to the [Java Garbage-First Garbage Collector Tuning manual](https://docs.oracle.com/en/java/javase/17/gctuning/garbage-first-garbage-collector-tuning.html#GUID-90E30ACA-8040-432E-B3A0-1E0440AB556A).
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Usage with Kotlin Notebook Plugin
2+
3+
The [Kotlin Notebook Plugin for IntelliJ IDEA](https://plugins.jetbrains.com/plugin/16340-kotlin-notebook), combined with Kotlin DataFrame, offers powerful data analysis capabilities within an interactive environment. Here are key features:
4+
5+
- **Visual Data Exploration**: View and navigate through your data using paginated tables. Drill down into nested data if your DataFrame contains nested structures.
6+
- **Intuitive Sorting**: Sort data with a single click on column headers, facilitating rapid data organization and analysis.
7+
- **Convenient Data Copying**: Copy data from tables for use in other tools or analyses.
8+
- **Export Functionality**: Export your data to various formats including CSV and Excel for further analysis in other applications.
9+
10+
To get started, ensure you have the latest version of the Kotlin Notebook Plugin installed in IntelliJ IDEA, and begin exploring your data using Kotlin DataFrames in your notebook cells.

0 commit comments

Comments
 (0)