mmd-critic

Name	mmd-critic JSON
Version	0.1.0 JSON
	download
home_page	https://github.com/PhysBoom/mmd_critic
Summary	Python package for the MMD Critic method
upload_time	2024-08-25 19:10:15
maintainer	None
docs_url	None
author	Matthew Chak
requires_python	>=3.6
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # mmd-critic

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/yourusername/mmd-critic/blob/main/LICENSE)

A Python package for implementing the Maximum Mean Discrepancy Critic (MMD-Critic) method. This method is commonly used to find prototypes and criticisms (outliers, roughly speaking) in datasets.

## Installation

You can install the package via pip:

```bash
pip install mmd-critic
```

## Usage

```python
from mmd_critic import MMDCritic
from mmd_critic.kernels import RBFKernel

critic = MMDCritic(X, RBFKernel(sigma=1))

protos = critic.select_prototypes(50)
criticisms = critic.select_criticisms(10, protos)
```

See more in the [examples](https://github.com/PhysBoom/mmd_critic/tree/main/examples)

## More Info

Read my [article](https://medium.com/@physboom/the-mmd-critic-method-explained-c6a77f2dbf18) for more info on the MMD critic method. I also encourage you to read the original [paper](https://papers.nips.cc/paper_files/paper/2016/hash/5680522b8e2bb01943234bce7bf84534-Abstract.html).

## Acknowledgements

The implementation here is based on Been Kim's [original implementation](https://github.com/BeenKim/MMD-critic/tree/master) and [paper](https://papers.nips.cc/paper_files/paper/2016/hash/5680522b8e2bb01943234bce7bf84534-Abstract.html)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/PhysBoom/mmd_critic",
    "name": "mmd-critic",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "Matthew Chak",
    "author_email": "mchak@calpoly.edu",
    "download_url": "https://files.pythonhosted.org/packages/b3/02/208d9e524af0e69b4e4d587d727372d30e871a89e6316a2e9623b902dc60/mmd_critic-0.1.0.tar.gz",
    "platform": null,
    "description": "# mmd-critic\n\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/yourusername/mmd-critic/blob/main/LICENSE)\n\nA Python package for implementing the Maximum Mean Discrepancy Critic (MMD-Critic) method. This method is commonly used to find prototypes and criticisms (outliers, roughly speaking) in datasets.\n\n## Installation\n\nYou can install the package via pip:\n\n```bash\npip install mmd-critic\n```\n\n## Usage\n\n```python\nfrom mmd_critic import MMDCritic\nfrom mmd_critic.kernels import RBFKernel\n\ncritic = MMDCritic(X, RBFKernel(sigma=1))\n\nprotos = critic.select_prototypes(50)\ncriticisms = critic.select_criticisms(10, protos)\n```\n\nSee more in the [examples](https://github.com/PhysBoom/mmd_critic/tree/main/examples)\n\n## More Info\n\nRead my [article](https://medium.com/@physboom/the-mmd-critic-method-explained-c6a77f2dbf18) for more info on the MMD critic method. I also encourage you to read the original [paper](https://papers.nips.cc/paper_files/paper/2016/hash/5680522b8e2bb01943234bce7bf84534-Abstract.html).\n\n## Acknowledgements\n\nThe implementation here is based on Been Kim's [original implementation](https://github.com/BeenKim/MMD-critic/tree/master) and [paper](https://papers.nips.cc/paper_files/paper/2016/hash/5680522b8e2bb01943234bce7bf84534-Abstract.html)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python package for the MMD Critic method",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/PhysBoom/mmd_critic"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b8f3ce8559dbe26132d99ab783895516ded6308306e88888ad9f842b3513391a",
                "md5": "d9c4cec7a17b86b16029d5ccc3bacdb0",
                "sha256": "37907643e71123374c3a19797e70427f880e5f19aec9f3b7d797359cc3804d53"
            },
            "downloads": -1,
            "filename": "mmd_critic-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d9c4cec7a17b86b16029d5ccc3bacdb0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 8830,
            "upload_time": "2024-08-25T19:10:14",
            "upload_time_iso_8601": "2024-08-25T19:10:14.296120Z",
            "url": "https://files.pythonhosted.org/packages/b8/f3/ce8559dbe26132d99ab783895516ded6308306e88888ad9f842b3513391a/mmd_critic-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b302208d9e524af0e69b4e4d587d727372d30e871a89e6316a2e9623b902dc60",
                "md5": "e2a75de209a3370b0ce18680fd981ec4",
                "sha256": "07d73af7182897c90d110dcb2dd61310e2342d8a5efb2225cf3ce36341a67f99"
            },
            "downloads": -1,
            "filename": "mmd_critic-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e2a75de209a3370b0ce18680fd981ec4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 6926,
            "upload_time": "2024-08-25T19:10:15",
            "upload_time_iso_8601": "2024-08-25T19:10:15.894888Z",
            "url": "https://files.pythonhosted.org/packages/b3/02/208d9e524af0e69b4e4d587d727372d30e871a89e6316a2e9623b902dc60/mmd_critic-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-25 19:10:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "PhysBoom",
    "github_project": "mmd_critic",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "mmd-critic"
}