scikit-dimension 0.3.2__tar.gz → 0.3.4__tar.gz

{scikit-dimension-0.3.2 → scikit-dimension-0.3.4}/.gitignore

@@ -1,4 +1,6 @@
-.vscode
+*.vscode
+*.idea
+*.ini
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

scikit-dimension-0.3.4/.readthedocs.yml

@@ -0,0 +1,20 @@
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.7"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+python:
+  install:
+    - requirements: doc/requirements.txt
+    - requirements: requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc

{scikit-dimension-0.3.2/scikit_dimension.egg-info → scikit-dimension-0.3.4}/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.1
 Name: scikit-dimension
-Version: 0.3.2
+Version: 0.3.4
 Summary: scikit-dimension is a Python module for intrinsic dimension estimation built according to the scikit-learn API and distributed under the 3-Clause BSD license..
 Home-page: https://github.com/j-bac/scikit-dimension
-Download-URL: https://github.com/j-bac/scikit-dimension
 Maintainer: Jonathan Bac
 License: BSD-3-clause
+Download-URL: https://github.com/j-bac/scikit-dimension
+Platform: UNKNOWN
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved
 Classifier: Programming Language :: Python
@@ -19,3 +20,6 @@ Classifier: Programming Language :: Python :: 3.8
 Provides-Extra: tests
 Provides-Extra: docs
 License-File: LICENSE
+
+UNKNOWN
+

{scikit-dimension-0.3.2 → scikit-dimension-0.3.4}/README.md

@@ -1,50 +1,49 @@
-[![Build status](https://ci.appveyor.com/api/projects/status/tvumlfad69g6ap3u/branch/master?svg=true)](https://ci.appveyor.com/project/j-bac/scikit-dimension/branch/master)
-[![CircleCI](https://circleci.com/gh/scikit-learn-contrib/scikit-dimension/tree/master.svg?style=shield)](https://app.circleci.com/pipelines/github/scikit-learn-contrib/scikit-dimension)
-[![Documentation Status](https://readthedocs.org/projects/scikit-dimension/badge/?version=latest)](https://scikit-dimension.readthedocs.io/en/latest/?badge=latest)
-[![codecov](https://codecov.io/gh/j-bac/scikit-dimension/branch/master/graph/badge.svg)](https://codecov.io/gh/j-bac/scikit-dimension)
-[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/j-bac/scikit-dimension.svg?logo=lgtm&logoWidth=18&label=%20code%20quality)](https://lgtm.com/projects/g/j-bac/scikit-dimension/context:python)
-[![GitHub license](https://img.shields.io/github/license/j-bac/scikit-dimension)](https://github.com/j-bac/scikit-dimension/blob/master/LICENSE)
-[![Downloads](https://pepy.tech/badge/scikit-dimension)](https://pepy.tech/project/scikit-dimension)
-
-# scikit-dimension
-
-scikit-dimension is a Python module for intrinsic dimension estimation built according to the [scikit-learn](https://github.com/scikit-learn/scikit-learn) API and distributed under the 3-Clause BSD license.
-
-Please refer to the [documentation](https://scikit-dimension.readthedocs.io) and the [paper](https://www.mdpi.com/1099-4300/23/10/1368) for detailed API, examples and references
-
-### Installation
-
-Using pip:
-```bash
-pip install scikit-dimension
-```
-
-From source:
-```bash
-git clone https://github.com/j-bac/scikit-dimension
-cd scikit-dimension
-pip install .
-```
- 
-### Quick start
-
-Local and global estimators can be used in this way:
-
-```python
-import skdim
-import numpy as np
-
-#generate data : np.array (n_points x n_dim). Here a uniformly sampled 5-ball embedded in 10 dimensions
-data = np.zeros((1000,10))
-data[:,:5] = skdim.datasets.hyperBall(n = 1000, d = 5, radius = 1, random_state = 0)
-
-#estimate global intrinsic dimension
-danco = skdim.id.DANCo().fit(data)
-#estimate local intrinsic dimension (dimension in k-nearest-neighborhoods around each point):
-lpca = skdim.id.lPCA().fit_pw(data,
-                              n_neighbors = 100,
-                              n_jobs = 1)
-                            
-#get estimated intrinsic dimension
-print(danco.dimension_, np.mean(lpca.dimension_pw_)) 
-```
+[![Build status](https://ci.appveyor.com/api/projects/status/tvumlfad69g6ap3u/branch/master?svg=true)](https://ci.appveyor.com/project/j-bac/scikit-dimension/branch/master)
+[![CircleCI](https://circleci.com/gh/scikit-learn-contrib/scikit-dimension/tree/master.svg?style=shield)](https://app.circleci.com/pipelines/github/scikit-learn-contrib/scikit-dimension)
+[![Documentation Status](https://readthedocs.org/projects/scikit-dimension/badge/?version=latest)](https://scikit-dimension.readthedocs.io/en/latest/?badge=latest)
+[![codecov](https://codecov.io/gh/j-bac/scikit-dimension/branch/master/graph/badge.svg)](https://codecov.io/gh/j-bac/scikit-dimension)
+[![GitHub license](https://img.shields.io/github/license/j-bac/scikit-dimension)](https://github.com/j-bac/scikit-dimension/blob/master/LICENSE)
+[![Downloads](https://pepy.tech/badge/scikit-dimension)](https://pepy.tech/project/scikit-dimension)
+ 
+# scikit-dimension
+
+scikit-dimension is a Python module for intrinsic dimension estimation built according to the [scikit-learn](https://github.com/scikit-learn/scikit-learn) API and distributed under the 3-Clause BSD license.
+
+Please refer to the [documentation](https://scikit-dimension.readthedocs.io) and the [paper](https://www.mdpi.com/1099-4300/23/10/1368) for detailed API, examples and references
+
+### Installation
+
+Using pip:
+```bash
+pip install scikit-dimension
+```
+
+From source:
+```bash
+git clone https://github.com/j-bac/scikit-dimension
+cd scikit-dimension
+pip install .
+```
+ 
+### Quick start
+
+Local and global estimators can be used in this way:
+
+```python
+import skdim
+import numpy as np
+
+#generate data : np.array (n_points x n_dim). Here a uniformly sampled 5-ball embedded in 10 dimensions
+data = np.zeros((1000,10))
+data[:,:5] = skdim.datasets.hyperBall(n = 1000, d = 5, radius = 1, random_state = 0)
+
+#estimate global intrinsic dimension
+danco = skdim.id.DANCo().fit(data)
+#estimate local intrinsic dimension (dimension in k-nearest-neighborhoods around each point):
+lpca = skdim.id.lPCA().fit_pw(data,
+                              n_neighbors = 100,
+                              n_jobs = 1)
+                            
+#get estimated intrinsic dimension
+print(danco.dimension_, np.mean(lpca.dimension_pw_)) 
+```