Fix readme

This commit is contained in:
Alexander Nozik 2022-07-24 12:01:02 +03:00
parent ad30c68eba
commit 1e8a8cac7e
No known key found for this signature in database
GPG Key ID: F7FCF2DD25C71357
30 changed files with 112 additions and 91 deletions
.github
.space
README.md
docs/templates
kmath-ast
kmath-commons
kmath-complex
kmath-core
kmath-coroutines
kmath-dimensions
kmath-ejml
kmath-for-real
kmath-functions
kmath-geometry
kmath-histograms
kmath-jafama
kmath-jupyter
kmath-kotlingrad
kmath-memory
kmath-multik
kmath-nd4j
kmath-optimization
kmath-stat
kmath-symja
kmath-tensorflow
kmath-tensors
kmath-trajectory
kmath-viktor

3
.github/CODEOWNERS vendored Normal file

@ -0,0 +1,3 @@
@altavir
/kmath-trajectory @ESchouten

0
.space/CODEOWNERS Normal file

@ -86,8 +86,8 @@ module definitions below. The module stability could have the following levels:
> **Maturity**: PROTOTYPE
>
> **Features:**
> - [complex](kmath-complex/src/commonMain/kotlin/space/kscience/kmath/complex/Complex.kt) : Complex Numbers
> - [quaternion](kmath-complex/src/commonMain/kotlin/space/kscience/kmath/complex/Quaternion.kt) : Quaternions
> - [complex](kmath-complex/src/commonMain/kotlin/space/kscience/kmath/complex/Complex.kt) : Complex numbers operations
> - [quaternion](kmath-complex/src/commonMain/kotlin/space/kscience/kmath/complex/Quaternion.kt) : Quaternions and their composition
### [kmath-core](kmath-core)
@ -240,11 +240,21 @@ One can still use generic algebras though.
> - [linear algebra operations](kmath-tensors/src/commonMain/kotlin/space/kscience/kmath/tensors/api/LinearOpsTensorAlgebra.kt) : Advanced linear algebra operations like LU decomposition, SVD, etc.
### [kmath-trajectory](kmath-trajectory)
> Path and trajectory optimization
>
> **Maturity**: PROTOTYPE
### [kmath-viktor](kmath-viktor)
>
>
> **Maturity**: DEVELOPMENT
### [test-utils](test-utils)
>
>
> **Maturity**: EXPERIMENTAL
## Multi-platform support
@ -261,8 +271,7 @@ performance and flexibility.
We expect to focus on creating convenient universal API first and then work on increasing performance for specific
cases. We expect the worst KMath benchmarks will perform better than native Python, but worse than optimized
native/SciPy (mostly due to boxing operations on primitive numbers). The best performance of optimized parts could be
better than SciPy.
native/SciPy (mostly due to boxing operations on primitive numbers). The best performance of optimized parts could be better than SciPy.
## Requirements
@ -294,4 +303,4 @@ Gradle `6.0+` is required for multiplatform artifacts.
The project requires a lot of additional work. The most important thing we need is a feedback about what features are
required the most. Feel free to create feature requests. We are also welcome to code contributions, especially in issues
marked with
[waiting for a hero](https://github.com/mipt-npm/kmath/labels/waiting%20for%20a%20hero) label.
[waiting for a hero](https://github.com/mipt-npm/kmath/labels/waiting%20for%20a%20hero) label.

@ -69,8 +69,7 @@ performance and flexibility.
We expect to focus on creating convenient universal API first and then work on increasing performance for specific
cases. We expect the worst KMath benchmarks will perform better than native Python, but worse than optimized
native/SciPy (mostly due to boxing operations on primitive numbers). The best performance of optimized parts could be
better than SciPy.
native/SciPy (mostly due to boxing operations on primitive numbers). The best performance of optimized parts could be better than SciPy.
## Requirements
@ -102,11 +101,4 @@ Gradle `6.0+` is required for multiplatform artifacts.
The project requires a lot of additional work. The most important thing we need is a feedback about what features are
required the most. Feel free to create feature requests. We are also welcome to code contributions, especially in issues
marked with
[waiting for a hero](https://github.com/mipt-npm/kmath/labels/waiting%20for%20a%20hero) label.
## Author
Erik Schouten
Github: ESchouten
Email: erik-schouten@hotmail.nl
[waiting for a hero](https://github.com/mipt-npm/kmath/labels/waiting%20for%20a%20hero) label.

@ -10,7 +10,7 @@ Extensions to MST API: transformations, dynamic compilation and visualization.
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-ast:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-ast:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -20,7 +20,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-ast:0.3.0'
implementation 'space.kscience:kmath-ast:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -31,7 +31,7 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-ast:0.3.0")
implementation("space.kscience:kmath-ast:0.3.1-dev-1")
}
```

@ -6,7 +6,7 @@ Commons math binding for kmath
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-commons:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-commons:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-commons:0.3.0'
implementation 'space.kscience:kmath-commons:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -27,6 +27,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-commons:0.3.0")
implementation("space.kscience:kmath-commons:0.3.1-dev-1")
}
```

@ -2,13 +2,13 @@
Complex and hypercomplex number systems in KMath.
- [complex](src/commonMain/kotlin/space/kscience/kmath/complex/Complex.kt) : Complex Numbers
- [quaternion](src/commonMain/kotlin/space/kscience/kmath/complex/Quaternion.kt) : Quaternions
- [complex](src/commonMain/kotlin/space/kscience/kmath/complex/Complex.kt) : Complex numbers operations
- [quaternion](src/commonMain/kotlin/space/kscience/kmath/complex/Quaternion.kt) : Quaternions and their composition
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-complex:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-complex:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -18,7 +18,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-complex:0.3.0'
implementation 'space.kscience:kmath-complex:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -29,6 +29,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-complex:0.3.0")
implementation("space.kscience:kmath-complex:0.3.1-dev-1")
}
```

@ -15,7 +15,7 @@ performance calculations to code generation.
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-core:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-core:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -25,7 +25,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-core:0.3.0'
implementation 'space.kscience:kmath-core:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -36,6 +36,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-core:0.3.0")
implementation("space.kscience:kmath-core:0.3.1-dev-1")
}
```

@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-coroutines:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-coroutines:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-coroutines:0.3.0'
implementation 'space.kscience:kmath-coroutines:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -27,6 +27,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-coroutines:0.3.0")
implementation("space.kscience:kmath-coroutines:0.3.1-dev-1")
}
```

@ -6,7 +6,7 @@ A proof of concept module for adding type-safe dimensions to structures
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-dimensions:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-dimensions:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-dimensions:0.3.0'
implementation 'space.kscience:kmath-dimensions:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -27,6 +27,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-dimensions:0.3.0")
implementation("space.kscience:kmath-dimensions:0.3.1-dev-1")
}
```

@ -9,7 +9,7 @@ EJML based linear algebra implementation.
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-ejml:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-ejml:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -19,7 +19,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-ejml:0.3.0'
implementation 'space.kscience:kmath-ejml:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -30,6 +30,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-ejml:0.3.0")
implementation("space.kscience:kmath-ejml:0.3.1-dev-1")
}
```

@ -9,7 +9,7 @@ Specialization of KMath APIs for Double numbers.
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-for-real:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-for-real:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -19,7 +19,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-for-real:0.3.0'
implementation 'space.kscience:kmath-for-real:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -30,6 +30,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-for-real:0.3.0")
implementation("space.kscience:kmath-for-real:0.3.1-dev-1")
}
```

@ -11,7 +11,7 @@ Functions and interpolations.
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-functions:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-functions:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -21,7 +21,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-functions:0.3.0'
implementation 'space.kscience:kmath-functions:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -32,6 +32,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-functions:0.3.0")
implementation("space.kscience:kmath-functions:0.3.1-dev-1")
}
```

@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-geometry:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-geometry:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-geometry:0.3.0'
implementation 'space.kscience:kmath-geometry:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -27,6 +27,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-geometry:0.3.0")
implementation("space.kscience:kmath-geometry:0.3.1-dev-1")
}
```

@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-histograms:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-histograms:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-histograms:0.3.0'
implementation 'space.kscience:kmath-histograms:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -27,6 +27,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-histograms:0.3.0")
implementation("space.kscience:kmath-histograms:0.3.1-dev-1")
}
```

@ -7,7 +7,7 @@ Integration with [Jafama](https://github.com/jeffhain/jafama).
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-jafama:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-jafama:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -17,7 +17,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-jafama:0.3.0'
implementation 'space.kscience:kmath-jafama:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -28,7 +28,7 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-jafama:0.3.0")
implementation("space.kscience:kmath-jafama:0.3.1-dev-1")
}
```

@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-jupyter:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-jupyter:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-jupyter:0.3.0'
implementation 'space.kscience:kmath-jupyter:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -27,6 +27,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-jupyter:0.3.0")
implementation("space.kscience:kmath-jupyter:0.3.1-dev-1")
}
```

@ -8,7 +8,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-kotlingrad:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-kotlingrad:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -18,7 +18,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-kotlingrad:0.3.0'
implementation 'space.kscience:kmath-kotlingrad:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -29,6 +29,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-kotlingrad:0.3.0")
implementation("space.kscience:kmath-kotlingrad:0.3.1-dev-1")
}
```

@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-memory:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-memory:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-memory:0.3.0'
implementation 'space.kscience:kmath-memory:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -27,6 +27,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-memory:0.3.0")
implementation("space.kscience:kmath-memory:0.3.1-dev-1")
}
```

@ -6,7 +6,7 @@ JetBrains Multik connector
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-multik:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-multik:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-multik:0.3.0'
implementation 'space.kscience:kmath-multik:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -27,6 +27,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-multik:0.3.0")
implementation("space.kscience:kmath-multik:0.3.1-dev-1")
}
```

@ -9,7 +9,7 @@ ND4J based implementations of KMath abstractions.
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-nd4j:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-nd4j:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -19,7 +19,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-nd4j:0.3.0'
implementation 'space.kscience:kmath-nd4j:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -30,7 +30,7 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-nd4j:0.3.0")
implementation("space.kscience:kmath-nd4j:0.3.1-dev-1")
}
```

@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-optimization:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-optimization:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-optimization:0.3.0'
implementation 'space.kscience:kmath-optimization:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -27,6 +27,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-optimization:0.3.0")
implementation("space.kscience:kmath-optimization:0.3.1-dev-1")
}
```

@ -6,7 +6,7 @@
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-stat:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-stat:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-stat:0.3.0'
implementation 'space.kscience:kmath-stat:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -27,6 +27,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-stat:0.3.0")
implementation("space.kscience:kmath-stat:0.3.1-dev-1")
}
```

@ -6,7 +6,7 @@ Symja integration module
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-symja:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-symja:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-symja:0.3.0'
implementation 'space.kscience:kmath-symja:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -27,6 +27,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-symja:0.3.0")
implementation("space.kscience:kmath-symja:0.3.1-dev-1")
}
```

@ -6,7 +6,7 @@ Google tensorflow connector
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-tensorflow:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-tensorflow:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-tensorflow:0.3.0'
implementation 'space.kscience:kmath-tensorflow:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -27,6 +27,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-tensorflow:0.3.0")
implementation("space.kscience:kmath-tensorflow:0.3.1-dev-1")
}
```

@ -9,7 +9,7 @@ Common linear algebra operations on tensors.
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-tensors:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-tensors:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -19,7 +19,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-tensors:0.3.0'
implementation 'space.kscience:kmath-tensors:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -30,6 +30,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-tensors:0.3.0")
implementation("space.kscience:kmath-tensors:0.3.1-dev-1")
}
```

@ -1,12 +1,11 @@
# Module kmath-trajectory
# kmath-trajectory
## Usage
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-trajectory:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-trajectory:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -16,7 +15,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-trajectory:0.3.0'
implementation 'space.kscience:kmath-trajectory:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -27,6 +26,9 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-trajectory:0.3.0")
implementation("space.kscience:kmath-trajectory:0.3.1-dev-1")
}
```
## Contributors
Erik Schouten (github: @ESchouten, email: erik-schouten@hotmail.nl)

@ -11,5 +11,7 @@ kotlin.sourceSets.commonMain {
}
readme {
description = "Path and trajectory optimization"
maturity = ru.mipt.npm.gradle.Maturity.PROTOTYPE
propertyByTemplate("artifact", rootProject.file("docs/templates/ARTIFACT-TEMPLATE.md"))
}

@ -0,0 +1,13 @@
# kmath-trajectory
${features}
${artifact}
## Author
Erik Schouten
Github: ESchouten
Email: erik-schouten@hotmail.nl

@ -6,7 +6,7 @@ Binding for https://github.com/JetBrains-Research/viktor
## Artifact:
The Maven coordinates of this project are `space.kscience:kmath-viktor:0.3.0`.
The Maven coordinates of this project are `space.kscience:kmath-viktor:0.3.1-dev-1`.
**Gradle Groovy:**
```groovy
@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:kmath-viktor:0.3.0'
implementation 'space.kscience:kmath-viktor:0.3.1-dev-1'
}
```
**Gradle Kotlin DSL:**
@ -27,6 +27,6 @@ repositories {
}
dependencies {
implementation("space.kscience:kmath-viktor:0.3.0")
implementation("space.kscience:kmath-viktor:0.3.1-dev-1")
}
```