Skip to content

Commit 6b1039c

Browse files
Merge pull request #1606 from Kotlin/update_readme
update readme
2 parents b997b28 + 7df20e3 commit 6b1039c

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ You could find the following articles there:
6363

6464
### What's new
6565

66-
1.0.0-Beta3: [Release notes](https://github.com/Kotlin/dataframe/releases/tag/v1.0.0-Beta3)
66+
1.0.0-Beta4: [Release notes](https://github.com/Kotlin/dataframe/releases/tag/v1.0.0-Beta4)
6767

6868
Check out this [notebook with new features](examples/notebooks/feature_overviews/0.15/new_features.ipynb) in v0.15.
6969

@@ -85,6 +85,7 @@ You can include all the necessary dependencies and imports in the notebook using
8585
%use dataframe
8686
```
8787

88+
This will add the `dataframe` of the version bundled in the selected Kotlin Jupyter kernel.
8889
You can use `%useLatestDescriptors`
8990
to get the latest stable version without updating the Kotlin kernel:
9091

@@ -96,9 +97,22 @@ to get the latest stable version without updating the Kotlin kernel:
9697
Or manually specify the version:
9798

9899
```
99-
%use dataframe($dataframe_version)
100+
%use dataframe(1.0.0-Beta4n)
100101
```
101102

103+
> [!WARNING]
104+
> Please, use `0.16.0-736` Kotlin Jupyter kernel version or higher for descriptor compatibility
105+
>
106+
> Use specified `1.0.0-Beta4n` version in Kotlin Notebook.
107+
> Due to [an known issue](https://github.com/Kotlin/dataframe/issues/1116),
108+
> common `dataframe:1.0.0-Beta4` version works incorrectly in Notebook.
109+
>
110+
> If you use [`kandy`](https://github.com/Kotlin/kandy) in your notebook, add it after the `dataframe`:
111+
> ```kotlin
112+
> %useLatestDescriptors
113+
> %use dataframe, kandy
114+
> ```
115+
102116
Refer to the
103117
[Get started with Kotlin DataFrame in Kotlin Notebook](https://kotlin.github.io/dataframe/gettingstartedkotlinnotebook.html)
104118
for details.
@@ -109,7 +123,7 @@ Add dependencies in the build.gradle.kts script:
109123
110124
```kotlin
111125
dependencies {
112-
implementation("org.jetbrains.kotlinx:dataframe:1.0.0-Beta3")
126+
implementation("org.jetbrains.kotlinx:dataframe:1.0.0-Beta4")
113127
}
114128
```
115129
@@ -200,6 +214,8 @@ other recommended versions.
200214
| 1.0.0-Beta2 | 8 / 11 | 2.0.20 | 0.12.0-383 | 18.1.0 | 2.2.20-dev-3524 | 0.8.1-dev-66 |
201215
| 1.0.0-Beta3n (notebooks) | 8 / 11 | 2.2.20 | 0.15.0-587 (K1 only) | 18.3.0 | - | 0.8.1n |
202216
| 1.0.0-Beta3 | 8 / 11 | 2.2.20 | 0.15.0-587 | 18.3.0 | 2.2.20 / IDEA 2025.2+ | 0.8.1 |
217+
| 1.0.0-Beta4n (notebooks) | 8 / 11 | 2.2.21 | 0.16.0-736 | 18.3.0 | - | 0.8.3 |
218+
| 1.0.0-Beta4 | 8 / 11 | 2.2.21 | 0.16.0-736 | 18.3.0 | 2.2.21 / IDEA 2025.2+ | 0.8.3 |
203219
204220
## Code of Conduct
205221

0 commit comments

Comments
 (0)