Git Product home page Git Product logo

Comments (2)

patrick-kidger avatar patrick-kidger commented on May 3, 2024 1

I think the __slots__ is unnecessary on a class that can never be instantiated. :)

But otherwise @mivanit's solution is a good one! I usually recommend writing something like

class f:
    def __class_getitem__(cls, item):
        return Float[torch.Tensor, item]

which is essentially the same thing as @mivanit's solution, but without the bells-and-whistles like docstrings and no-instantiation etc.

Note that this won't work with static type checkers, though. (Support for static type checking is the reason that jaxtyping works the way that it does.) If you do want to support them too then typically the best you can do is something like

from torch import Tensor as loat
from jaxtyping import Float as F

F[loat, "b w h"]

...wihch is obviously a huge hack to work around the heavy limitations of static type checkers.

from jaxtyping.

mivanit avatar mivanit commented on May 3, 2024

Here's what I use, no idea if it's best practice. It works with beartype for me, although I've done only pretty limited tests

import typing

import jaxtyping
import torch
import numpy as np

def jaxtype_factory(
		name: str,
		jax_dtype: type,
		array_type: type = jaxtyping.Float,
	) -> type:

	class _BaseArray:
		"""jaxtyping shorthand
		jax_dtype = {jax_dtype}
		array_type = {array_type}
		"""

		__slots__ = ()

		def __new__(cls, *args, **kwargs):
			raise TypeError("Type FArray cannot be instantiated.")

		def __init_subclass__(cls, *args, **kwargs):
			raise TypeError(f"Cannot subclass {cls.__name__}")

		@typing._tp_cache
		def __class_getitem__(cls, params):
			if isinstance(params, str):
				return array_type[jax_dtype, params]
			else:
				raise Exception(f"unexpected type for params:\n{type(params) = }\n{params = }")

	_BaseArray.__name__ = name
	_BaseArray.__doc__ = _BaseArray.__doc__.format(
		jax_dtype=repr(jax_dtype),
		array_type=repr(array_type),
	)

	return _BaseArray

# this makes linters happy
class F_Tensor(torch.Tensor):
	@typing._tp_cache
	def __class_getitem__(cls, params):
		raise NotImplementedError()

F_Tensor = jaxtype_factory("F_Tensor", torch.Tensor, jaxtyping.Float)

from jaxtyping.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.