Skip to main content

URI-ABD: Clustered Learning of Approximate Manifolds

Installation

python3 -m pip install pyclam

Usage

import numpy as np

from pyclam.datasets import bullseye
from pyclam.manifold import Manifold
from pyclam import criterion

# Get the data.
data, _ = bullseye()
# data is a numpy.ndarray in this case but it could just as easily be a numpy.memmap if your data cannot fit in RAM.
# We used memmaps for the research, though it does impose file-io costs.

manifold = Manifold(data=data, metric='euclidean')
# Any metric allowed by scipy's cdist function is allowed in Manifold.
# You can also define your own distance function. It will work so long as scipy allows it.

manifold.build(criterion.MaxDepth(20), criterion.MinRadius(0.25))
# Manifold.build can optionally take any number of early stopping criteria.
# pyclam.criterion defines some criteria that we have used in research.
# You are free to define your own.
# Take a look at pyclam/criterion.py for hints of how to define custom criteria.

# A sample rho-nearest neighbors search query
query, radius = data[0], 0.05
results = manifold.find_points(point=query, radius=radius)
# results is a dictionary of indexes of hits in data and the distance to those hits.

# A sample k-nearest neighbors search query
results = manifold.find_knn(point=query, k=25)

pyclam.Manifold relies on the Graph and Cluster classes. You can import these and work with them directly if you so choose. We have written good docs for each class and method. Go crazy.

Contributing

Pull requests and bug reports are welcome. For major changes, please first open an issue to discuss what you would like to change.

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyclam-0.2.8.tar.gz (21.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyclam-0.2.8-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

Details for the file pyclam-0.2.8.tar.gz.

File metadata

  • Download URL: pyclam-0.2.8.tar.gz
  • Upload date:
  • Size: 21.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.9

File hashes

Hashes for pyclam-0.2.8.tar.gz
Algorithm Hash digest
SHA256 1bd89385b926143719a6d77eb81fd5c371f4914ec951d9c702a5fea472f8862f
MD5 2902c0c391eada5b9112f2de9333ca71
BLAKE2b-256 5cb79e9109e4a01d68ec4b85f3f27455d3f66aa080107eed5d3b7d8280610668

See more details on using hashes here.

File details

Details for the file pyclam-0.2.8-py3-none-any.whl.

File metadata

  • Download URL: pyclam-0.2.8-py3-none-any.whl
  • Upload date:
  • Size: 22.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.9

File hashes

Hashes for pyclam-0.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 b235dbc3f651f706965015da285a7fa42d76f960cad9c3d7dcf198569bdb1f6d
MD5 826be383d3c3a042d2c0464ad1476912
BLAKE2b-256 53d42366e565076390de2456389c25e89585642a455adbd93c7687f9506dbe66

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page