-
Notifications
You must be signed in to change notification settings - Fork 73
improve concept docs structure #1305
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
AndreiKingsley
wants to merge
3
commits into
master
Choose a base branch
from
concepts_restructure
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Support | ||
|
||
* <img src="github-mark.svg" alt="GitHub logo" height="24"/> | ||
[**Issue Tracker**](https://github.com/Kotlin/dataframe/issues) | ||
|
||
If you find a bug or have an idea for a new feature, | ||
file an issue in our [DataFrame GitHub repository](https://github.com/Kotlin/dataframe). | ||
|
||
* <img src="https://kotlinlang.org/docs/images/slack.svg" alt="Slack logo" height="24"/> | ||
[**Community**](https://github.com/Kotlin/dataframe/issues) | ||
|
||
Peer-to-peer support is available on the Kotlin Slack | ||
[#datascience](https://kotlinlang.slack.com/archives/C4W52CFEZ) channel | ||
([request an invite](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up?_gl=1*1ssyqy3*_gcl_au*MTk5NzUwODYzOS4xNzQ2NzkxMDMz*FPAU*MTk5NzUwODYzOS4xNzQ2NzkxMDMz*_ga*MTE0ODQ1MzY3OS4xNzM4OTY1NzM3*_ga_9J976DJZ68*czE3NTE1NDUxODUkbzIyNyRnMCR0MTc1MTU0NTE4NSRqNjAkbDAkaDA.)). |
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
docs/StardustDocs/topics/gradleReference.md → ...cs/concepts/DataSchemaGenerationGradle.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ics/DataSchema-Data-Classes-Generation.md → ...s/concepts/DataSchemaGenerationMethods.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# Concepts And Principles | ||
|
||
<web-summary> | ||
Learn what Kotlin DataFrame is about — its core concepts, design principles, and usage philosophy. | ||
</web-summary> | ||
|
||
<card-summary> | ||
Discover the fundamentals of the library — | ||
understand key concepts, motivation, and the overall structure of the library. | ||
</card-summary> | ||
|
||
<link-summary> | ||
Explore the fundamentals of Kotlin DataFrame — | ||
understand key concepts, motivation, and the overall structure of the library. | ||
</link-summary> | ||
|
||
|
||
<show-structure depth="3"/> | ||
|
||
|
||
## What is a dataframe | ||
|
||
A *dataframe* is an abstraction for working with structured data. | ||
Essentially, it’s a 2-dimensional table with labeled columns of potentially different types. | ||
You can think of it like a spreadsheet or SQL table, or a dictionary of series objects. | ||
|
||
The handiness of this abstraction is not in the table itself but in a set of operations defined on it. | ||
The Kotlin DataFrame library is an idiomatic Kotlin DSL defining such operations. | ||
The process of working with dataframe is often called *data wrangling* which | ||
is the process of transforming and mapping data from one "raw" data form into another format | ||
that is more appropriate for analytics and visualization. | ||
The goal of data wrangling is to ensure quality and useful data. | ||
|
||
## Main Features and Concepts | ||
|
||
* [**Hierarchical**](hierarchical.md) — the Kotlin DataFrame library provides an ability to read and present data from different sources, | ||
including not only plain **CSV** but also **JSON** or **[SQL databases](readSqlDatabases.md)**. | ||
This is why it was designed to be hierarchical and allows nesting of columns and cells. | ||
* **Functional** — the data processing pipeline is organized in a chain of [`DataFrame`](DataFrame.md) transformation operations. | ||
* **Immutable** — every operation returns a new instance of [`DataFrame`](DataFrame.md) reusing underlying storage wherever it's possible. | ||
* **Readable** — data transformation operations are defined in DSL close to natural language. | ||
* **Practical** — provides simple solutions for common problems and the ability to perform complex tasks. | ||
* **Minimalistic** — simple, yet powerful data model of three [column kinds](DataColumn.md#column-kinds). | ||
* [**Interoperable**](collectionsInterop.md) — convertable with Kotlin data classes and collections. | ||
This also means conversion to/from other libraries' data structures is usually quite straightforward! | ||
See our [examples](https://github.com/Kotlin/dataframe/tree/master/examples/idea-examples/unsupported-data-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/examples) | ||
for some conversions between DataFrame and [Apache Spark](https://github.com/Kotlin/dataframe/tree/master/examples/idea-examples/unsupported-data-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/examples/spark), [Multik](https://github.com/Kotlin/dataframe/tree/master/examples/idea-examples/unsupported-data-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/examples/multik), and [JetBrains Exposed](https://github.com/Kotlin/dataframe/tree/master/examples/idea-examples/unsupported-data-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/examples/exposed). | ||
* **Generic** — can store objects of any type, not only numbers or strings. | ||
* **Typesafe** — the Kotlin DataFrame library provides a mechanism of on-the-fly [**generation of extension properties**](extensionPropertiesApi.md) | ||
that correspond to the columns of a dataframe. | ||
In interactive notebooks like Jupyter or Datalore, the generation runs after each cell execution. | ||
In IntelliJ IDEA there's a Gradle plugin for generation properties based on CSV file or JSON file. | ||
Also, we’re working on a compiler plugin that infers and transforms [`DataFrame`](DataFrame.md) schema while typing. | ||
You can now clone this [project with many examples](https://github.com/koperagen/df-plugin-demo) showcasing how it allows you to reliably use our most convenient extension properties API. | ||
The generated properties ensure you’ll never misspell column name and don’t mess up with its type, and of course nullability is also preserved. | ||
* [**Polymorphic**](schemas.md) — | ||
if all columns of a [`DataFrame`](DataFrame.md) instance are presented in another dataframe, | ||
then the first one will be seen as a superclass for the latter. | ||
This means you can define a function on an interface with some set of columns | ||
and then execute it safely on any [`DataFrame`](DataFrame.md) which contains this same set of columns. | ||
In notebooks, this works out-of-the-box. | ||
In ordinary projects, this requires casting (for now). |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we put a redirect from overview -> concepts in writerside?