Skip to content

Commit

Permalink
[DOC] author credits to tslearn authors (#6269)
Browse files Browse the repository at this point in the history
With increased visibility of the authors field in the docs (e.g., in the
reworked [estimator
overview](https://www.sktime.net/en/latest/estimator_overview.html)), we
should make sure it properly reflects contribution. Also see #5938.

This adds upstream authors to the author fields of interfaced estimators
from `tslearn` - based on best guesses inferred from author strings and
commit history.
  • Loading branch information
fkiraly committed Apr 11, 2024
1 parent 00ad9a3 commit 91611fb
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 12 deletions.
Expand Up @@ -4,7 +4,7 @@


class KNeighborsTimeSeriesClassifierTslearn(_TslearnAdapter, BaseClassifier):
"""K-nearest neighbors Time Series Classifier.
"""K-nearest neighbors Time Series Classifier, from tslearn.
Direct interface to ``tslearn.neighbors.KNeighborsTimeSeriesClassifier``.
Expand Down Expand Up @@ -60,7 +60,7 @@ class KNeighborsTimeSeriesClassifierTslearn(_TslearnAdapter, BaseClassifier):
_tags = {
# packaging info
# --------------
"authors": "fkiraly",
"authors": ["rtavenar", "fkiraly"], # rtavenar credit for interfaced code
"python_dependencies": "tslearn",
# estimator type
# --------------
Expand Down
4 changes: 2 additions & 2 deletions sktime/clustering/k_means/_k_means_tslearn.py
Expand Up @@ -6,7 +6,7 @@


class TimeSeriesKMeansTslearn(_TslearnAdapter, BaseClusterer):
"""K-means clustering for time-series data.
"""K-means clustering for time-series data, from tslearn.
Direct interface to ``tslearn.clustering.TimeSeriesKMeans``.
Expand Down Expand Up @@ -102,7 +102,7 @@ class TimeSeriesKMeansTslearn(_TslearnAdapter, BaseClusterer):
_tags = {
# packaging info
# --------------
"authors": "fkiraly",
"authors": ["rtavenar", "fkiraly"], # rtavenar credit for interfaced code
"python_dependencies": "tslearn",
# estimator type
# --------------
Expand Down
4 changes: 2 additions & 2 deletions sktime/clustering/k_shapes.py
Expand Up @@ -9,7 +9,7 @@


class TimeSeriesKShapes(_TslearnAdapter, BaseClusterer):
"""Kshape clustering for time series.
"""K-shape clustering for time series, from tslearn.
Direct interface to ``tslearn.clustering.KShape``.
Expand Down Expand Up @@ -52,7 +52,7 @@ class TimeSeriesKShapes(_TslearnAdapter, BaseClusterer):
_tags = {
# packaging info
# --------------
"authors": "fkiraly",
"authors": ["rtavenar", "fkiraly"], # rtavenar credit for interfaced code
"python_dependencies": "tslearn",
# estimator type
# --------------
Expand Down
6 changes: 4 additions & 2 deletions sktime/clustering/kernel_k_means.py
Expand Up @@ -9,7 +9,9 @@


class TimeSeriesKernelKMeans(_TslearnAdapter, BaseClusterer):
"""Kernel algorithm wrapper tslearns implementation.
"""Kernel k-means clustering, from tslearn.
Direct interface to ``tslearn.clustering.KernelKMeans``.
Parameters
----------
Expand Down Expand Up @@ -67,7 +69,7 @@ class TimeSeriesKernelKMeans(_TslearnAdapter, BaseClusterer):
_tags = {
# packaging info
# --------------
"authors": "fkiraly",
"authors": ["rtavenar", "fkiraly"], # rtavenar credit for interfaced code
"python_dependencies": "tslearn",
# estimator type
# --------------
Expand Down
3 changes: 2 additions & 1 deletion sktime/dists_kernels/ctw.py
Expand Up @@ -53,7 +53,8 @@ class CtwDistTslearn(_TslearnPwTrafoAdapter, BasePairwiseTransformerPanel):
_tags = {
# packaging info
# --------------
"authors": ["fkiraly"],
"authors": ["rtavenar", "ysoullard", "chusloj", "fkiraly"],
# rtavenar, ysoullard, chusloj credit for interfaced code
"python_dependencies": ["tslearn"],
# estimator type
# --------------
Expand Down
3 changes: 2 additions & 1 deletion sktime/dists_kernels/dtw/_dtw_tslearn.py
Expand Up @@ -53,7 +53,8 @@ class DtwDistTslearn(_TslearnPwTrafoAdapter, BasePairwiseTransformerPanel):
_tags = {
# packaging info
# --------------
"authors": ["fkiraly"],
"authors": ["rtavenar", "yanncabanes", "fkiraly"],
# rtavenar, yanncabanes credit for interfaced code
"python_dependencies": ["tslearn"],
# estimator type
# --------------
Expand Down
3 changes: 2 additions & 1 deletion sktime/dists_kernels/gak.py
Expand Up @@ -37,7 +37,8 @@ class GAKernel(_TslearnPwTrafoAdapter, BasePairwiseTransformerPanel):
_tags = {
# packaging info
# --------------
"authors": ["fkiraly"],
"authors": ["rtavenar", "yanncabanes", "fkiraly"],
# rtavenar, yanncabanes credit for interfaced code
"python_dependencies": ["tslearn"],
# estimator type
# --------------
Expand Down
2 changes: 1 addition & 1 deletion sktime/dists_kernels/lcss.py
Expand Up @@ -47,7 +47,7 @@ class LcssTslearn(_TslearnPwTrafoAdapter, BasePairwiseTransformerPanel):
_tags = {
# packaging info
# --------------
"authors": ["fkiraly"],
"authors": ["danisodu", "rtavenar", "fkiraly"],
"python_dependencies": ["tslearn"],
# estimator type
# --------------
Expand Down

0 comments on commit 91611fb

Please sign in to comment.