Skip to main content

Implementation of the neural tangent kernel for scikit-learn's Gaussian process module.

Project description

Neural Tangent Kernel for scikit-learn Gaussian Processes

GitHub Workflow Status PyPI PyPI - Python Version PyPI - Downloads

scikit-ntk is implementation of the neural tangent kernel (NTK) for the scikit-learn machine learning library as part of "An Empirical Analysis of the Laplace and Neural Tangent Kernels" master's thesis (found at http://hdl.handle.net/20.500.12680/d504rr81v and https://arxiv.org/abs/2208.03761). This library is meant to directly integrate with sklearn.gaussian_process module. This implementation of the NTK can be used in combination with other kernels to train and predict with Gaussian process regressors and classifiers.

Installation

Dependencies

scikit-ntk requires:

  • Python (>=3.7)
  • scikit-learn (>=1.0.1)

User installation

In terminal using pip run:

pip install scikit-ntk

Usage

Usage is described in examples/usage.py; however, to get started simply import the NeuralTangentKernel class:

from skntk import NeuralTangentKernel as NTK

kernel_ntk = NTK(D=3, bias=0.01, bias_bounds=(1e-6, 1e6))

Once declared, usage is the same as other scikit-learn kernels.

Building

Python Poetry (>=1.2) is required if you wish to build scikit-ntk from source. In order to build follow these steps:

  1. Clone the repository
git clone git@github.com:392781/scikit-ntk.git
  1. Enable a Poetry virtual environment
poetry shell
  1. Build and install
poetry build
poetry install --with dev

Citation

If you use scikit-ntk in your scientific work, please use the following citation alongside the scikit-learn citations found at https://scikit-learn.org/stable/about.html#citing-scikit-learn:

@mastersthesis{lencevicius2022laplacentk,
  author  = "Ronaldas Paulius Lencevicius",
  title   = "An Empirical Analysis of the Laplace and Neural Tangent Kernels",
  school  = "California State Polytechnic University, Pomona",
  year    = "2022",
  month   = "August",
  note    = {\url{http://hdl.handle.net/20.500.12680/d504rr81v}}
}

Project details


Download files

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

Source Distribution

scikit_ntk-1.1.2.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

scikit_ntk-1.1.2-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file scikit_ntk-1.1.2.tar.gz.

File metadata

  • Download URL: scikit_ntk-1.1.2.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.8 Linux/5.15.0-1022-azure

File hashes

Hashes for scikit_ntk-1.1.2.tar.gz
Algorithm Hash digest
SHA256 8c5db8b7ab777efe2e4c7752214a87ee56850ca3b97d4c70c6e01ba1156f67a1
MD5 648fea0bbbaba3fde5ca47041d19deb3
BLAKE2b-256 78fd2bda70355dc65a09ad9e204ebfd0be8f3ad758c3a6f88cb974e77b0f9fde

See more details on using hashes here.

File details

Details for the file scikit_ntk-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: scikit_ntk-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.8 Linux/5.15.0-1022-azure

File hashes

Hashes for scikit_ntk-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5490145318bef33dcfab433356f9d7a7021d6cec9d7076e50feecf0f3a3e6233
MD5 e64caede1e5edb28d24676e4cb9d9230
BLAKE2b-256 d7cad5b669723ceb760a843de362edaf2c9b561433b1cd0cc5e69a169c67c2e3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page