metrx

A library containing a collection of distance and similarity measures for data analysis

https://github.com/pompetzki/metrx

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 2 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.0%) to scientific vocabulary

Last synced: 6 months ago · JSON representation ·

Repository

A library containing a collection of distance and similarity measures for data analysis

Basic Info

Host: GitHub
Owner: pompetzki
License: mit
Language: Python
Default Branch: main
Homepage:
Size: 209 KB

Statistics

Stars: 16
Watchers: 4
Forks: 0
Open Issues: 1
Releases: 1

Created over 1 year ago · Last pushed 7 months ago

Metadata Files

Readme License Citation

A lightweight JAX-based library offering a collection of distance and similarity measures for data analysis. Designed for scalability and accelerator support, it includes high-performance, parallelizable implementations of a wide range of commonly used metrics.

Installation

You have the choice to install the latest release via PyPI by running pip install metrx or you do an editable installation by cloning this repository and then running

bash pip install -e .

Implemented Metrics

This library is still in development and more metrics will be added over time. The following metrics are currently implemented.

Distance Measures

Statistical Measures

Examples

To test, there are two examples: Either compare batches of particles bash python examples/example_particle_data.py or batches of time series data bash python examples/example_time_series_data.py

Citation

If you use this libarary in your work, please consider citing it as follows: @software{metrx2024github, author = {Pompetzki, Kay and Gruner, Theo and Al-Hafez, Firas, and Le, An T., and Peters, Jan}, title = {MetrX: A JAX-Based Collection of Similarity and Statistical Measures for Accelerated Data Analysis.}, url = {https://github.com/pompetzki/metrx}, year = {2024}, }

Owner

Name: Kay Pompetzki (Hansel)
Login: pompetzki
Kind: user
Location: Germany
Company: Technische Universität Darmstadt

Website: https://www.ias.informatik.tu-darmstadt.de/Team/KayHansel
Twitter: kay_pompetzki
Repositories: 1
Profile: https://github.com/pompetzki

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Pompetzki
    given-names: Kay
  - family-names: Gruner
    given-names: Theo
  - family-names: Al-Hafez
    given-names: Firas
  - family-names: Le
    given-names: An T.
  - family-names: Peters
    given-names: Jan
title: "MetrX: A JAX-Based Collection of Similarity and Statistical Measures for Accelerated Data Analysis."
date-released: 2024-11-26

GitHub Events

Total

Release event: 1
Watch event: 9
Delete event: 1
Push event: 11
Pull request event: 2
Create event: 4

Last Year

Release event: 1
Watch event: 9
Delete event: 1
Push event: 11
Pull request event: 2
Create event: 4

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 0
Total pull requests: 1
Average time to close issues: N/A
Average time to close pull requests: 1 minute
Total issue authors: 0
Total pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 1
Average time to close issues: N/A
Average time to close pull requests: 1 minute
Issue authors: 0
Pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

theogruner (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- pypi 520 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 2
Total maintainers: 3

pypi.org: metrx

"A library containing a collection of distance and similarity measures to compare time series data."

Homepage: https://github.com/pompetzki/metrx
Documentation: https://metrx.readthedocs.io/
License: MIT License Copyright (c) 2024 Kay Hansel Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Latest release: 0.1.0
published about 1 year ago

Versions: 2
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 520 Last month

Rankings

Dependent packages count: 9.9%

Average: 32.8%

Dependent repos count: 55.6%

Maintainers (3)

Firas994 KayPompetzki theogruner