<!--
<p align="center">
<img src="https://github.com/cthoyt/class-resolver/raw/main/docs/source/logo.png" height="150">
</p>
-->
<h1 align="center">
Class Resolver
</h1>
<p align="center">
<a href="https://github.com/cthoyt/class-resolver/actions/workflows/tests.yml">
<img alt="Tests" src="https://github.com/cthoyt/class-resolver/actions/workflows/tests.yml/badge.svg" /></a>
<a href="https://pypi.org/project/class_resolver">
<img alt="PyPI" src="https://img.shields.io/pypi/v/class_resolver" /></a>
<a href="https://pypi.org/project/class_resolver">
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/class_resolver" /></a>
<a href="https://github.com/cthoyt/class-resolver/blob/main/LICENSE">
<img alt="PyPI - License" src="https://img.shields.io/pypi/l/class_resolver" /></a>
<a href='https://class_resolver.readthedocs.io/en/latest/?badge=latest'>
<img src='https://readthedocs.org/projects/class_resolver/badge/?version=latest' alt='Documentation Status' /></a>
<a href="https://codecov.io/gh/cthoyt/class-resolver/branch/main">
<img src="https://codecov.io/gh/cthoyt/class-resolver/branch/main/graph/badge.svg" alt="Codecov status" /></a>
<a href="https://github.com/cthoyt/cookiecutter-python-package">
<img alt="Cookiecutter template from @cthoyt" src="https://img.shields.io/badge/Cookiecutter-snekpack-blue" /></a>
<a href="https://github.com/astral-sh/ruff">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;"></a>
<a href="https://github.com/cthoyt/class-resolver/blob/main/.github/CODE_OF_CONDUCT.md">
<img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg" alt="Contributor Covenant"/></a>
<a href="https://zenodo.org/badge/latestdoi/343741010">
<img src="https://zenodo.org/badge/343741010.svg" alt="DOI"></a>
</p>
Lookup and instantiate classes with style.
## 💪 Getting Started
```python
from class_resolver import ClassResolver
from dataclasses import dataclass
class Base: pass
@dataclass
class A(Base):
name: str
@dataclass
class B(Base):
name: str
# Index
resolver = ClassResolver([A, B], base=Base)
# Lookup
assert A == resolver.lookup('A')
# Instantiate with a dictionary
assert A(name='hi') == resolver.make('A', {'name': 'hi'})
# Instantiate with kwargs
assert A(name='hi') == resolver.make('A', name='hi')
# A pre-instantiated class will simply be passed through
assert A(name='hi') == resolver.make(A(name='hi'))
```
## 🤖 Writing Extensible Machine Learning Models with `class-resolver`
Assume you've implemented a simple multi-layer perceptron in PyTorch:
```python
from itertools import chain
from more_itertools import pairwise
from torch import nn
class MLP(nn.Sequential):
def __init__(self, dims: list[int]):
super().__init__(chain.from_iterable(
(
nn.Linear(in_features, out_features),
nn.ReLU(),
)
for in_features, out_features in pairwise(dims)
))
```
This MLP uses a hard-coded rectified linear unit as the non-linear activation
function between layers. We can generalize this MLP to use a variety of
non-linear activation functions by adding an argument to its `__init__()`
function like in:
```python
from itertools import chain
from more_itertools import pairwise
from torch import nn
class MLP(nn.Sequential):
def __init__(self, dims: list[int], activation: str = "relu"):
if activation == "relu":
activation = nn.ReLU()
elif activation == "tanh":
activation = nn.Tanh()
elif activation == "hardtanh":
activation = nn.Hardtanh()
else:
raise KeyError(f"Unsupported activation: {activation}")
super().__init__(chain.from_iterable(
(
nn.Linear(in_features, out_features),
activation,
)
for in_features, out_features in pairwise(dims)
))
```
The first issue with this implementation is it relies on a hard-coded set of
conditional statements and is therefore hard to extend. It can be improved by
using a dictionary lookup:
```python
from itertools import chain
from more_itertools import pairwise
from torch import nn
activation_lookup: dict[str, nn.Module] = {
"relu": nn.ReLU(),
"tanh": nn.Tanh(),
"hardtanh": nn.Hardtanh(),
}
class MLP(nn.Sequential):
def __init__(self, dims: list[int], activation: str = "relu"):
activation = activation_lookup[activation]
super().__init__(chain.from_iterable(
(
nn.Linear(in_features, out_features),
activation,
)
for in_features, out_features in pairwise(dims)
))
```
This approach is rigid because it requires pre-instantiation of the activations.
If we needed to vary the arguments to the `nn.HardTanh` class, the previous
approach wouldn't work. We can change the implementation to lookup on the class
_before instantiation_ then optionally pass some arguments:
```python
from itertools import chain
from more_itertools import pairwise
from torch import nn
activation_lookup: dict[str, type[nn.Module]] = {
"relu": nn.ReLU,
"tanh": nn.Tanh,
"hardtanh": nn.Hardtanh,
}
class MLP(nn.Sequential):
def __init__(
self,
dims: list[int],
activation: str = "relu",
activation_kwargs: None | dict[str, any] = None,
):
activation_cls = activation_lookup[activation]
activation = activation_cls(**(activation_kwargs or {}))
super().__init__(chain.from_iterable(
(
nn.Linear(in_features, out_features),
activation,
)
for in_features, out_features in pairwise(dims)
))
```
This is pretty good, but it still has a few issues:
1. you have to manually maintain the `activation_lookup` dictionary,
2. you can't pass an instance or class through the `activation` keyword
3. you have to get the casing just right
4. the default is hard-coded as a string, which means this has to get copied
(error-prone) in any place that creates an MLP
5. you have to re-write this logic for all of your classes
Enter the `class_resolver` package, which takes care of all of these things
using the following:
```python
from itertools import chain
from class_resolver import ClassResolver, Hint
from more_itertools import pairwise
from torch import nn
activation_resolver = ClassResolver(
[nn.ReLU, nn.Tanh, nn.Hardtanh],
base=nn.Module,
default=nn.ReLU,
)
class MLP(nn.Sequential):
def __init__(
self,
dims: list[int],
activation: Hint[nn.Module] = None, # Hint = Union[None, str, nn.Module, type[nn.Module]]
activation_kwargs: None | dict[str, any] = None,
):
super().__init__(chain.from_iterable(
(
nn.Linear(in_features, out_features),
activation_resolver.make(activation, activation_kwargs),
)
for in_features, out_features in pairwise(dims)
))
```
Because this is such a common pattern, we've made it available through contrib
module in `class_resolver.contrib.torch`:
```python
from itertools import chain
from class_resolver import Hint
from class_resolver.contrib.torch import activation_resolver
from more_itertools import pairwise
from torch import nn
class MLP(nn.Sequential):
def __init__(
self,
dims: list[int],
activation: Hint[nn.Module] = None,
activation_kwargs: None | dict[str, any] = None,
):
super().__init__(chain.from_iterable(
(
nn.Linear(in_features, out_features),
activation_resolver.make(activation, activation_kwargs),
)
for in_features, out_features in pairwise(dims)
))
```
Now, you can instantiate the MLP with any of the following:
```python
MLP(dims=[10, 200, 40]) # uses default, which is ReLU
MLP(dims=[10, 200, 40], activation="relu") # uses lowercase
MLP(dims=[10, 200, 40], activation="ReLU") # uses stylized
MLP(dims=[10, 200, 40], activation=nn.ReLU) # uses class
MLP(dims=[10, 200, 40], activation=nn.ReLU()) # uses instance
MLP(dims=[10, 200, 40], activation="hardtanh", activation_kwargs={"min_val": 0.0, "max_value": 6.0}) # uses kwargs
MLP(dims=[10, 200, 40], activation=nn.HardTanh, activation_kwargs={"min_val": 0.0, "max_value": 6.0}) # uses kwargs
MLP(dims=[10, 200, 40], activation=nn.HardTanh(0.0, 6.0)) # uses instance
```
In practice, it makes sense to stick to using the strings in combination with
hyper-parameter optimization libraries like [Optuna](https://optuna.org/).
## 🚀 Installation
The most recent release can be installed from
[PyPI](https://pypi.org/project/class_resolver/) with uv:
```console
$ uv pip install class_resolver
```
or with pip:
```console
$ python3 -m pip install class_resolver
```
The most recent code and data can be installed directly from GitHub with uv:
```console
$ uv pip install git+https://github.com/cthoyt/class-resolver.git
```
or with pip:
```console
$ python3 -m pip install git+https://github.com/cthoyt/class-resolver.git
```
## 👐 Contributing
Contributions, whether filing an issue, making a pull request, or forking, are
appreciated. See
[CONTRIBUTING.md](https://github.com/cthoyt/class-resolver/blob/master/.github/CONTRIBUTING.md)
for more information on getting involved.
## 👋 Attribution
### ⚖️ License
The code in this package is licensed under the MIT License.
<!--
### 📖 Citation
Citation goes here!
-->
<!--
### 🎁 Support
This project has been supported by the following organizations (in alphabetical order):
- [Biopragmatics Lab](https://biopragmatics.github.io)
-->
<!--
### 💰 Funding
This project has been supported by the following grants:
| Funding Body | Program | Grant Number |
|---------------|--------------------------------------------------------------|--------------|
| Funder | [Grant Name (GRANT-ACRONYM)](https://example.com/grant-link) | ABCXYZ |
-->
### 🍪 Cookiecutter
This package was created with
[@audreyfeldroy](https://github.com/audreyfeldroy)'s
[cookiecutter](https://github.com/cookiecutter/cookiecutter) package using
[@cthoyt](https://github.com/cthoyt)'s
[cookiecutter-snekpack](https://github.com/cthoyt/cookiecutter-snekpack)
template.
## 🛠️ For Developers
<details>
<summary>See developer instructions</summary>
The final section of the README is for if you want to get involved by making a
code contribution.
### Development Installation
To install in development mode, use the following:
```console
$ git clone git+https://github.com/cthoyt/class-resolver.git
$ cd class-resolver
$ uv pip install -e .
```
Alternatively, install using pip:
```console
$ python3 -m pip install -e .
```
### Updating Package Boilerplate
This project uses `cruft` to keep boilerplate (i.e., configuration, contribution
guidelines, documentation configuration) up-to-date with the upstream
cookiecutter package. Install cruft with either `uv tool install cruft` or
`python3 -m pip install cruft` then run:
```console
$ cruft update
```
More info on Cruft's update command is available
[here](https://github.com/cruft/cruft?tab=readme-ov-file#updating-a-project).
### 🥼 Testing
After cloning the repository and installing `tox` with
`uv tool install tox --with tox-uv` or `python3 -m pip install tox tox-uv`, the
unit tests in the `tests/` folder can be run reproducibly with:
```console
$ tox -e py
```
Additionally, these tests are automatically re-run with each commit in a
[GitHub Action](https://github.com/cthoyt/class-resolver/actions?query=workflow%3ATests).
### 📖 Building the Documentation
The documentation can be built locally using the following:
```console
$ git clone git+https://github.com/cthoyt/class-resolver.git
$ cd class-resolver
$ tox -e docs
$ open docs/build/html/index.html
```
The documentation automatically installs the package as well as the `docs` extra
specified in the [`pyproject.toml`](pyproject.toml). `sphinx` plugins like
`texext` can be added there. Additionally, they need to be added to the
`extensions` list in [`docs/source/conf.py`](docs/source/conf.py).
The documentation can be deployed to [ReadTheDocs](https://readthedocs.io) using
[this guide](https://docs.readthedocs.io/en/stable/intro/import-guide.html). The
[`.readthedocs.yml`](.readthedocs.yml) YAML file contains all the configuration
you'll need. You can also set up continuous integration on GitHub to check not
only that Sphinx can build the documentation in an isolated environment (i.e.,
with `tox -e docs-test`) but also that
[ReadTheDocs can build it too](https://docs.readthedocs.io/en/stable/pull-requests.html).
#### Configuring ReadTheDocs
1. Log in to ReadTheDocs with your GitHub account to install the integration at
https://readthedocs.org/accounts/login/?next=/dashboard/
2. Import your project by navigating to https://readthedocs.org/dashboard/import
then clicking the plus icon next to your repository
3. You can rename the repository on the next screen using a more stylized name
(i.e., with spaces and capital letters)
4. Click next, and you're good to go!
### 📦 Making a Release
#### Configuring Zenodo
[Zenodo](https://zenodo.org) is a long-term archival system that assigns a DOI
to each release of your package.
1. Log in to Zenodo via GitHub with this link:
https://zenodo.org/oauth/login/github/?next=%2F. This brings you to a page
that lists all of your organizations and asks you to approve installing the
Zenodo app on GitHub. Click "grant" next to any organizations you want to
enable the integration for, then click the big green "approve" button. This
step only needs to be done once.
2. Navigate to https://zenodo.org/account/settings/github/, which lists all of
your GitHub repositories (both in your username and any organizations you
enabled). Click the on/off toggle for any relevant repositories. When you
make a new repository, you'll have to come back to this
After these steps, you're ready to go! After you make "release" on GitHub (steps
for this are below), you can navigate to
https://zenodo.org/account/settings/github/repository/cthoyt/class-resolver to
see the DOI for the release and link to the Zenodo record for it.
#### Registering with the Python Package Index (PyPI)
You only have to do the following steps once.
1. Register for an account on the
[Python Package Index (PyPI)](https://pypi.org/account/register)
2. Navigate to https://pypi.org/manage/account and make sure you have verified
your email address. A verification email might not have been sent by default,
so you might have to click the "options" dropdown next to your address to get
to the "re-send verification email" button
3. 2-Factor authentication is required for PyPI since the end of 2023 (see this
[blog post from PyPI](https://blog.pypi.org/posts/2023-05-25-securing-pypi-with-2fa/)).
This means you have to first issue account recovery codes, then set up
2-factor authentication
4. Issue an API token from https://pypi.org/manage/account/token
#### Configuring your machine's connection to PyPI
You have to do the following steps once per machine.
```console
$ uv tool install keyring
$ keyring set https://upload.pypi.org/legacy/ __token__
$ keyring set https://test.pypi.org/legacy/ __token__
```
Note that this deprecates previous workflows using `.pypirc`.
#### Uploading to PyPI
After installing the package in development mode and installing `tox` with
`uv tool install tox --with tox-uv` or `python3 -m pip install tox tox-uv`, run
the following from the console:
```console
$ tox -e finish
```
This script does the following:
1. Uses [bump-my-version](https://github.com/callowayproject/bump-my-version) to
switch the version number in the `pyproject.toml`, `CITATION.cff`,
`src/class_resolver/version.py`, and
[`docs/source/conf.py`](docs/source/conf.py) to not have the `-dev` suffix
2. Packages the code in both a tar archive and a wheel using
[`uv build`](https://docs.astral.sh/uv/guides/publish/#building-your-package)
3. Uploads to PyPI using
[`uv publish`](https://docs.astral.sh/uv/guides/publish/#publishing-your-package).
4. Push to GitHub. You'll need to make a release going with the commit where the
version was bumped.
5. Bump the version to the next patch. If you made big changes and want to bump
the version by minor, you can use `tox -e bumpversion -- minor` after.
#### Releasing on GitHub
1. Navigate to https://github.com/cthoyt/class-resolver/releases/new to draft a
new release
2. Click the "Choose a Tag" dropdown and select the tag corresponding to the
release you just made
3. Click the "Generate Release Notes" button to get a quick outline of recent
changes. Modify the title and description as you see fit
4. Click the big green "Publish Release" button
This will trigger Zenodo to assign a DOI to your release as well.
</details>
Raw data
{
"_id": null,
"home_page": null,
"name": "class-resolver",
"maintainer": "Charles Tapley Hoyt",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Charles Tapley Hoyt <cthoyt@gmail.com>",
"keywords": "snekpack, cookiecutter, development tool, configurability",
"author": "Charles Tapley Hoyt",
"author_email": "Charles Tapley Hoyt <cthoyt@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/6f/a1/963d658b8eb0b98dbd83ce5555ad22c47cae10e083d1a0954d541669d6c3/class_resolver-0.7.0.tar.gz",
"platform": null,
"description": "<!--\n<p align=\"center\">\n <img src=\"https://github.com/cthoyt/class-resolver/raw/main/docs/source/logo.png\" height=\"150\">\n</p>\n-->\n\n<h1 align=\"center\">\n Class Resolver\n</h1>\n\n<p align=\"center\">\n <a href=\"https://github.com/cthoyt/class-resolver/actions/workflows/tests.yml\">\n <img alt=\"Tests\" src=\"https://github.com/cthoyt/class-resolver/actions/workflows/tests.yml/badge.svg\" /></a>\n <a href=\"https://pypi.org/project/class_resolver\">\n <img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/class_resolver\" /></a>\n <a href=\"https://pypi.org/project/class_resolver\">\n <img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/class_resolver\" /></a>\n <a href=\"https://github.com/cthoyt/class-resolver/blob/main/LICENSE\">\n <img alt=\"PyPI - License\" src=\"https://img.shields.io/pypi/l/class_resolver\" /></a>\n <a href='https://class_resolver.readthedocs.io/en/latest/?badge=latest'>\n <img src='https://readthedocs.org/projects/class_resolver/badge/?version=latest' alt='Documentation Status' /></a>\n <a href=\"https://codecov.io/gh/cthoyt/class-resolver/branch/main\">\n <img src=\"https://codecov.io/gh/cthoyt/class-resolver/branch/main/graph/badge.svg\" alt=\"Codecov status\" /></a> \n <a href=\"https://github.com/cthoyt/cookiecutter-python-package\">\n <img alt=\"Cookiecutter template from @cthoyt\" src=\"https://img.shields.io/badge/Cookiecutter-snekpack-blue\" /></a>\n <a href=\"https://github.com/astral-sh/ruff\">\n <img src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\" alt=\"Ruff\" style=\"max-width:100%;\"></a>\n <a href=\"https://github.com/cthoyt/class-resolver/blob/main/.github/CODE_OF_CONDUCT.md\">\n <img src=\"https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg\" alt=\"Contributor Covenant\"/></a>\n <a href=\"https://zenodo.org/badge/latestdoi/343741010\">\n <img src=\"https://zenodo.org/badge/343741010.svg\" alt=\"DOI\"></a>\n</p>\n\nLookup and instantiate classes with style.\n\n## \ud83d\udcaa Getting Started\n\n```python\nfrom class_resolver import ClassResolver\nfrom dataclasses import dataclass\n\nclass Base: pass\n\n@dataclass\nclass A(Base):\n name: str\n\n@dataclass\nclass B(Base):\n name: str\n\n# Index\nresolver = ClassResolver([A, B], base=Base)\n\n# Lookup\nassert A == resolver.lookup('A')\n\n# Instantiate with a dictionary\nassert A(name='hi') == resolver.make('A', {'name': 'hi'})\n\n# Instantiate with kwargs\nassert A(name='hi') == resolver.make('A', name='hi')\n\n# A pre-instantiated class will simply be passed through\nassert A(name='hi') == resolver.make(A(name='hi'))\n```\n\n## \ud83e\udd16 Writing Extensible Machine Learning Models with `class-resolver`\n\nAssume you've implemented a simple multi-layer perceptron in PyTorch:\n\n```python\nfrom itertools import chain\n\nfrom more_itertools import pairwise\nfrom torch import nn\n\nclass MLP(nn.Sequential):\n def __init__(self, dims: list[int]):\n super().__init__(chain.from_iterable(\n (\n nn.Linear(in_features, out_features),\n nn.ReLU(),\n )\n for in_features, out_features in pairwise(dims)\n ))\n```\n\nThis MLP uses a hard-coded rectified linear unit as the non-linear activation\nfunction between layers. We can generalize this MLP to use a variety of\nnon-linear activation functions by adding an argument to its `__init__()`\nfunction like in:\n\n```python\nfrom itertools import chain\n\nfrom more_itertools import pairwise\nfrom torch import nn\n\nclass MLP(nn.Sequential):\n def __init__(self, dims: list[int], activation: str = \"relu\"):\n if activation == \"relu\":\n activation = nn.ReLU()\n elif activation == \"tanh\":\n activation = nn.Tanh()\n elif activation == \"hardtanh\":\n activation = nn.Hardtanh()\n else:\n raise KeyError(f\"Unsupported activation: {activation}\")\n super().__init__(chain.from_iterable(\n (\n nn.Linear(in_features, out_features),\n activation,\n )\n for in_features, out_features in pairwise(dims)\n ))\n```\n\nThe first issue with this implementation is it relies on a hard-coded set of\nconditional statements and is therefore hard to extend. It can be improved by\nusing a dictionary lookup:\n\n```python\nfrom itertools import chain\n\nfrom more_itertools import pairwise\nfrom torch import nn\n\nactivation_lookup: dict[str, nn.Module] = {\n \"relu\": nn.ReLU(),\n \"tanh\": nn.Tanh(),\n \"hardtanh\": nn.Hardtanh(),\n}\n\nclass MLP(nn.Sequential):\n def __init__(self, dims: list[int], activation: str = \"relu\"):\n activation = activation_lookup[activation]\n super().__init__(chain.from_iterable(\n (\n nn.Linear(in_features, out_features),\n activation,\n )\n for in_features, out_features in pairwise(dims)\n ))\n```\n\nThis approach is rigid because it requires pre-instantiation of the activations.\nIf we needed to vary the arguments to the `nn.HardTanh` class, the previous\napproach wouldn't work. We can change the implementation to lookup on the class\n_before instantiation_ then optionally pass some arguments:\n\n```python\nfrom itertools import chain\n\nfrom more_itertools import pairwise\nfrom torch import nn\n\nactivation_lookup: dict[str, type[nn.Module]] = {\n \"relu\": nn.ReLU,\n \"tanh\": nn.Tanh,\n \"hardtanh\": nn.Hardtanh,\n}\n\nclass MLP(nn.Sequential):\n def __init__(\n self,\n dims: list[int],\n activation: str = \"relu\",\n activation_kwargs: None | dict[str, any] = None,\n ):\n activation_cls = activation_lookup[activation]\n activation = activation_cls(**(activation_kwargs or {}))\n super().__init__(chain.from_iterable(\n (\n nn.Linear(in_features, out_features),\n activation,\n )\n for in_features, out_features in pairwise(dims)\n ))\n```\n\nThis is pretty good, but it still has a few issues:\n\n1. you have to manually maintain the `activation_lookup` dictionary,\n2. you can't pass an instance or class through the `activation` keyword\n3. you have to get the casing just right\n4. the default is hard-coded as a string, which means this has to get copied\n (error-prone) in any place that creates an MLP\n5. you have to re-write this logic for all of your classes\n\nEnter the `class_resolver` package, which takes care of all of these things\nusing the following:\n\n```python\nfrom itertools import chain\n\nfrom class_resolver import ClassResolver, Hint\nfrom more_itertools import pairwise\nfrom torch import nn\n\nactivation_resolver = ClassResolver(\n [nn.ReLU, nn.Tanh, nn.Hardtanh],\n base=nn.Module,\n default=nn.ReLU,\n)\n\nclass MLP(nn.Sequential):\n def __init__(\n self,\n dims: list[int],\n activation: Hint[nn.Module] = None, # Hint = Union[None, str, nn.Module, type[nn.Module]]\n activation_kwargs: None | dict[str, any] = None,\n ):\n super().__init__(chain.from_iterable(\n (\n nn.Linear(in_features, out_features),\n activation_resolver.make(activation, activation_kwargs),\n )\n for in_features, out_features in pairwise(dims)\n ))\n```\n\nBecause this is such a common pattern, we've made it available through contrib\nmodule in `class_resolver.contrib.torch`:\n\n```python\nfrom itertools import chain\n\nfrom class_resolver import Hint\nfrom class_resolver.contrib.torch import activation_resolver\nfrom more_itertools import pairwise\nfrom torch import nn\n\nclass MLP(nn.Sequential):\n def __init__(\n self,\n dims: list[int],\n activation: Hint[nn.Module] = None,\n activation_kwargs: None | dict[str, any] = None,\n ):\n super().__init__(chain.from_iterable(\n (\n nn.Linear(in_features, out_features),\n activation_resolver.make(activation, activation_kwargs),\n )\n for in_features, out_features in pairwise(dims)\n ))\n```\n\nNow, you can instantiate the MLP with any of the following:\n\n```python\nMLP(dims=[10, 200, 40]) # uses default, which is ReLU\nMLP(dims=[10, 200, 40], activation=\"relu\") # uses lowercase\nMLP(dims=[10, 200, 40], activation=\"ReLU\") # uses stylized\nMLP(dims=[10, 200, 40], activation=nn.ReLU) # uses class\nMLP(dims=[10, 200, 40], activation=nn.ReLU()) # uses instance\n\nMLP(dims=[10, 200, 40], activation=\"hardtanh\", activation_kwargs={\"min_val\": 0.0, \"max_value\": 6.0}) # uses kwargs\nMLP(dims=[10, 200, 40], activation=nn.HardTanh, activation_kwargs={\"min_val\": 0.0, \"max_value\": 6.0}) # uses kwargs\nMLP(dims=[10, 200, 40], activation=nn.HardTanh(0.0, 6.0)) # uses instance\n```\n\nIn practice, it makes sense to stick to using the strings in combination with\nhyper-parameter optimization libraries like [Optuna](https://optuna.org/).\n\n## \ud83d\ude80 Installation\n\nThe most recent release can be installed from\n[PyPI](https://pypi.org/project/class_resolver/) with uv:\n\n```console\n$ uv pip install class_resolver\n```\n\nor with pip:\n\n```console\n$ python3 -m pip install class_resolver\n```\n\nThe most recent code and data can be installed directly from GitHub with uv:\n\n```console\n$ uv pip install git+https://github.com/cthoyt/class-resolver.git\n```\n\nor with pip:\n\n```console\n$ python3 -m pip install git+https://github.com/cthoyt/class-resolver.git\n```\n\n## \ud83d\udc50 Contributing\n\nContributions, whether filing an issue, making a pull request, or forking, are\nappreciated. See\n[CONTRIBUTING.md](https://github.com/cthoyt/class-resolver/blob/master/.github/CONTRIBUTING.md)\nfor more information on getting involved.\n\n## \ud83d\udc4b Attribution\n\n### \u2696\ufe0f License\n\nThe code in this package is licensed under the MIT License.\n\n<!--\n### \ud83d\udcd6 Citation\n\nCitation goes here!\n-->\n\n<!--\n### \ud83c\udf81 Support\n\nThis project has been supported by the following organizations (in alphabetical order):\n\n- [Biopragmatics Lab](https://biopragmatics.github.io)\n\n-->\n\n<!--\n### \ud83d\udcb0 Funding\n\nThis project has been supported by the following grants:\n\n| Funding Body | Program | Grant Number |\n|---------------|--------------------------------------------------------------|--------------|\n| Funder | [Grant Name (GRANT-ACRONYM)](https://example.com/grant-link) | ABCXYZ |\n-->\n\n### \ud83c\udf6a Cookiecutter\n\nThis package was created with\n[@audreyfeldroy](https://github.com/audreyfeldroy)'s\n[cookiecutter](https://github.com/cookiecutter/cookiecutter) package using\n[@cthoyt](https://github.com/cthoyt)'s\n[cookiecutter-snekpack](https://github.com/cthoyt/cookiecutter-snekpack)\ntemplate.\n\n## \ud83d\udee0\ufe0f For Developers\n\n<details>\n <summary>See developer instructions</summary>\n\nThe final section of the README is for if you want to get involved by making a\ncode contribution.\n\n### Development Installation\n\nTo install in development mode, use the following:\n\n```console\n$ git clone git+https://github.com/cthoyt/class-resolver.git\n$ cd class-resolver\n$ uv pip install -e .\n```\n\nAlternatively, install using pip:\n\n```console\n$ python3 -m pip install -e .\n```\n\n### Updating Package Boilerplate\n\nThis project uses `cruft` to keep boilerplate (i.e., configuration, contribution\nguidelines, documentation configuration) up-to-date with the upstream\ncookiecutter package. Install cruft with either `uv tool install cruft` or\n`python3 -m pip install cruft` then run:\n\n```console\n$ cruft update\n```\n\nMore info on Cruft's update command is available\n[here](https://github.com/cruft/cruft?tab=readme-ov-file#updating-a-project).\n\n### \ud83e\udd7c Testing\n\nAfter cloning the repository and installing `tox` with\n`uv tool install tox --with tox-uv` or `python3 -m pip install tox tox-uv`, the\nunit tests in the `tests/` folder can be run reproducibly with:\n\n```console\n$ tox -e py\n```\n\nAdditionally, these tests are automatically re-run with each commit in a\n[GitHub Action](https://github.com/cthoyt/class-resolver/actions?query=workflow%3ATests).\n\n### \ud83d\udcd6 Building the Documentation\n\nThe documentation can be built locally using the following:\n\n```console\n$ git clone git+https://github.com/cthoyt/class-resolver.git\n$ cd class-resolver\n$ tox -e docs\n$ open docs/build/html/index.html\n```\n\nThe documentation automatically installs the package as well as the `docs` extra\nspecified in the [`pyproject.toml`](pyproject.toml). `sphinx` plugins like\n`texext` can be added there. Additionally, they need to be added to the\n`extensions` list in [`docs/source/conf.py`](docs/source/conf.py).\n\nThe documentation can be deployed to [ReadTheDocs](https://readthedocs.io) using\n[this guide](https://docs.readthedocs.io/en/stable/intro/import-guide.html). The\n[`.readthedocs.yml`](.readthedocs.yml) YAML file contains all the configuration\nyou'll need. You can also set up continuous integration on GitHub to check not\nonly that Sphinx can build the documentation in an isolated environment (i.e.,\nwith `tox -e docs-test`) but also that\n[ReadTheDocs can build it too](https://docs.readthedocs.io/en/stable/pull-requests.html).\n\n#### Configuring ReadTheDocs\n\n1. Log in to ReadTheDocs with your GitHub account to install the integration at\n https://readthedocs.org/accounts/login/?next=/dashboard/\n2. Import your project by navigating to https://readthedocs.org/dashboard/import\n then clicking the plus icon next to your repository\n3. You can rename the repository on the next screen using a more stylized name\n (i.e., with spaces and capital letters)\n4. Click next, and you're good to go!\n\n### \ud83d\udce6 Making a Release\n\n#### Configuring Zenodo\n\n[Zenodo](https://zenodo.org) is a long-term archival system that assigns a DOI\nto each release of your package.\n\n1. Log in to Zenodo via GitHub with this link:\n https://zenodo.org/oauth/login/github/?next=%2F. This brings you to a page\n that lists all of your organizations and asks you to approve installing the\n Zenodo app on GitHub. Click \"grant\" next to any organizations you want to\n enable the integration for, then click the big green \"approve\" button. This\n step only needs to be done once.\n2. Navigate to https://zenodo.org/account/settings/github/, which lists all of\n your GitHub repositories (both in your username and any organizations you\n enabled). Click the on/off toggle for any relevant repositories. When you\n make a new repository, you'll have to come back to this\n\nAfter these steps, you're ready to go! After you make \"release\" on GitHub (steps\nfor this are below), you can navigate to\nhttps://zenodo.org/account/settings/github/repository/cthoyt/class-resolver to\nsee the DOI for the release and link to the Zenodo record for it.\n\n#### Registering with the Python Package Index (PyPI)\n\nYou only have to do the following steps once.\n\n1. Register for an account on the\n [Python Package Index (PyPI)](https://pypi.org/account/register)\n2. Navigate to https://pypi.org/manage/account and make sure you have verified\n your email address. A verification email might not have been sent by default,\n so you might have to click the \"options\" dropdown next to your address to get\n to the \"re-send verification email\" button\n3. 2-Factor authentication is required for PyPI since the end of 2023 (see this\n [blog post from PyPI](https://blog.pypi.org/posts/2023-05-25-securing-pypi-with-2fa/)).\n This means you have to first issue account recovery codes, then set up\n 2-factor authentication\n4. Issue an API token from https://pypi.org/manage/account/token\n\n#### Configuring your machine's connection to PyPI\n\nYou have to do the following steps once per machine.\n\n```console\n$ uv tool install keyring\n$ keyring set https://upload.pypi.org/legacy/ __token__\n$ keyring set https://test.pypi.org/legacy/ __token__\n```\n\nNote that this deprecates previous workflows using `.pypirc`.\n\n#### Uploading to PyPI\n\nAfter installing the package in development mode and installing `tox` with\n`uv tool install tox --with tox-uv` or `python3 -m pip install tox tox-uv`, run\nthe following from the console:\n\n```console\n$ tox -e finish\n```\n\nThis script does the following:\n\n1. Uses [bump-my-version](https://github.com/callowayproject/bump-my-version) to\n switch the version number in the `pyproject.toml`, `CITATION.cff`,\n `src/class_resolver/version.py`, and\n [`docs/source/conf.py`](docs/source/conf.py) to not have the `-dev` suffix\n2. Packages the code in both a tar archive and a wheel using\n [`uv build`](https://docs.astral.sh/uv/guides/publish/#building-your-package)\n3. Uploads to PyPI using\n [`uv publish`](https://docs.astral.sh/uv/guides/publish/#publishing-your-package).\n4. Push to GitHub. You'll need to make a release going with the commit where the\n version was bumped.\n5. Bump the version to the next patch. If you made big changes and want to bump\n the version by minor, you can use `tox -e bumpversion -- minor` after.\n\n#### Releasing on GitHub\n\n1. Navigate to https://github.com/cthoyt/class-resolver/releases/new to draft a\n new release\n2. Click the \"Choose a Tag\" dropdown and select the tag corresponding to the\n release you just made\n3. Click the \"Generate Release Notes\" button to get a quick outline of recent\n changes. Modify the title and description as you see fit\n4. Click the big green \"Publish Release\" button\n\nThis will trigger Zenodo to assign a DOI to your release as well.\n\n</details>\n",
"bugtrack_url": null,
"license": null,
"summary": "Lookup and instantiate classes with style.",
"version": "0.7.0",
"project_urls": {
"Bug Tracker": "https://github.com/cthoyt/class-resolver/issues",
"Documentation": "https://class_resolver.readthedocs.io",
"Funding": "https://github.com/sponsors/cthoyt",
"Homepage": "https://github.com/cthoyt/class-resolver",
"Repository": "https://github.com/cthoyt/class-resolver.git"
},
"split_keywords": [
"snekpack",
" cookiecutter",
" development tool",
" configurability"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4bd719201748364392974be6fd6ff888a2d3b7aeae0a574121d186e8dcfc3592",
"md5": "2e9102ad40d48a84e7657353cd87af78",
"sha256": "147367c884d6a197ea87f75ed0686b2041561cbc3e2485bd0045ef8a59ac91f9"
},
"downloads": -1,
"filename": "class_resolver-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2e9102ad40d48a84e7657353cd87af78",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 31824,
"upload_time": "2025-08-21T20:42:47",
"upload_time_iso_8601": "2025-08-21T20:42:47.472859Z",
"url": "https://files.pythonhosted.org/packages/4b/d7/19201748364392974be6fd6ff888a2d3b7aeae0a574121d186e8dcfc3592/class_resolver-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6fa1963d658b8eb0b98dbd83ce5555ad22c47cae10e083d1a0954d541669d6c3",
"md5": "8af1edf1b045ef27eca09903aed3e9a9",
"sha256": "1a20c3e140b608ec29b56cf85433ee85fac6d7aebedf39717d71a56bb564618e"
},
"downloads": -1,
"filename": "class_resolver-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "8af1edf1b045ef27eca09903aed3e9a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 26878,
"upload_time": "2025-08-21T20:42:48",
"upload_time_iso_8601": "2025-08-21T20:42:48.610074Z",
"url": "https://files.pythonhosted.org/packages/6f/a1/963d658b8eb0b98dbd83ce5555ad22c47cae10e083d1a0954d541669d6c3/class_resolver-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-21 20:42:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cthoyt",
"github_project": "class-resolver",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "class-resolver"
}
JSON
