TensorPlay
latest (dev)
Copy
View Markdown

Latest development documentation · Updated 2026-10-08

MaskedTensor

class tensorplay.masked.MaskedTensor(data, mask, requires_grad=False)[source]

A pair of plain tensors data and mask presented as a single value.

mask is boolean and has the same shape as data. An element of data participates in computations only where the corresponding element of mask is True; positions where the mask is False are rendered as -- in the string representation and are replaced by a caller-supplied fill value by to_tensor().

The mask is always the source of truth for validity: masked-out entries of data may hold arbitrary values and are never read semantically.

This class is not a tensor subclass and does not hook into a dispatcher. Operations are applied through explicit methods (elementwise ops, reductions and structural ops) or through the masking-aware functions in tensorplay.masked, which accept both plain tensors and MaskedTensor inputs.

abs(*args, **kwargs)
abs_(*args, **kwargs)
absolute(*args, **kwargs)
absolute_(*args, **kwargs)
acos(*args, **kwargs)
acos_(*args, **kwargs)
acosh(*args, **kwargs)
acosh_(*args, **kwargs)
add(*args, **kwargs)
add_(*args, **kwargs)
all(*args, **kwargs)
amax(*args, **kwargs)
amin(*args, **kwargs)
angle(*args, **kwargs)
any(*args, **kwargs)
arccos(*args, **kwargs)
arccos_(*args, **kwargs)
arccosh(*args, **kwargs)
arccosh_(*args, **kwargs)
arcsin(*args, **kwargs)
arcsin_(*args, **kwargs)
arcsinh(*args, **kwargs)
arcsinh_(*args, **kwargs)
arctan(*args, **kwargs)
arctan2(*args, **kwargs)
arctan2_(*args, **kwargs)
arctan_(*args, **kwargs)
arctanh(*args, **kwargs)
arctanh_(*args, **kwargs)
argmax(*args, **kwargs)
argmin(*args, **kwargs)
asin(*args, **kwargs)
asin_(*args, **kwargs)
asinh(*args, **kwargs)
asinh_(*args, **kwargs)
atan(*args, **kwargs)
atan2(*args, **kwargs)
atan2_(*args, **kwargs)
atan_(*args, **kwargs)
atanh(*args, **kwargs)
atanh_(*args, **kwargs)
bitwise_and(*args, **kwargs)
bitwise_and_(*args, **kwargs)
bitwise_left_shift(*args, **kwargs)
bitwise_left_shift_(*args, **kwargs)
bitwise_not(*args, **kwargs)
bitwise_not_(*args, **kwargs)
bitwise_or(*args, **kwargs)
bitwise_or_(*args, **kwargs)
bitwise_right_shift(*args, **kwargs)
bitwise_right_shift_(*args, **kwargs)
bitwise_xor(*args, **kwargs)
bitwise_xor_(*args, **kwargs)
cat(*args, **kwargs)
ceil(*args, **kwargs)
ceil_(*args, **kwargs)
clamp(*args, **kwargs)
clamp_(*args, **kwargs)
clip(*args, **kwargs)
clip_(*args, **kwargs)
clone(*args, **kwargs)
col2im(*args, **kwargs)
conj(*args, **kwargs)
conj_physical(*args, **kwargs)
conj_physical_(*args, **kwargs)
contiguous(*args, **kwargs)
copy_(*args, **kwargs)
cos(*args, **kwargs)
cos_(*args, **kwargs)
cosh(*args, **kwargs)
cosh_(*args, **kwargs)
deg2rad(*args, **kwargs)
deg2rad_(*args, **kwargs)
detach(*args, **kwargs)
digamma(*args, **kwargs)
digamma_(*args, **kwargs)
div(*args, **kwargs)
div_(*args, **kwargs)
divide(*args, **kwargs)
divide_(*args, **kwargs)
eq(*args, **kwargs)
eq_(*args, **kwargs)
erf(*args, **kwargs)
erf_(*args, **kwargs)
erfc(*args, **kwargs)
erfc_(*args, **kwargs)
erfinv(*args, **kwargs)
erfinv_(*args, **kwargs)
exp(*args, **kwargs)
exp2(*args, **kwargs)
exp2_(*args, **kwargs)
exp_(*args, **kwargs)
expand(*args, **kwargs)
expm1(*args, **kwargs)
expm1_(*args, **kwargs)
fix(*args, **kwargs)
fix_(*args, **kwargs)
floor(*args, **kwargs)
floor_(*args, **kwargs)
floor_divide(*args, **kwargs)
floor_divide_(*args, **kwargs)
fmax(*args, **kwargs)
fmin(*args, **kwargs)
fmod(*args, **kwargs)
fmod_(*args, **kwargs)
frac(*args, **kwargs)
frac_(*args, **kwargs)
ge(*args, **kwargs)
ge_(*args, **kwargs)
greater(*args, **kwargs)
greater_(*args, **kwargs)
greater_equal(*args, **kwargs)
greater_equal_(*args, **kwargs)
gt(*args, **kwargs)
gt_(*args, **kwargs)
i0(*args, **kwargs)
i0_(*args, **kwargs)
im2col(*args, **kwargs)
index(*args, **kwargs)
indices(*args, **kwargs)
is_contiguous(*args, **kwargs)
is_same_size(*args, **kwargs)
isnan(*args, **kwargs)
item(*args, **kwargs)
le(*args, **kwargs)
le_(*args, **kwargs)
less(*args, **kwargs)
less_(*args, **kwargs)
less_equal(*args, **kwargs)
less_equal_(*args, **kwargs)
lgamma(*args, **kwargs)
lgamma_(*args, **kwargs)
log(*args, **kwargs)
log10(*args, **kwargs)
log10_(*args, **kwargs)
log1p(*args, **kwargs)
log1p_(*args, **kwargs)
log2(*args, **kwargs)
log2_(*args, **kwargs)
log_(*args, **kwargs)
logaddexp(*args, **kwargs)
logaddexp2(*args, **kwargs)
logit(*args, **kwargs)
logit_(*args, **kwargs)
lt(*args, **kwargs)
lt_(*args, **kwargs)
maximum(*args, **kwargs)
mean(*args, **kwargs)
minimum(*args, **kwargs)
mul(*args, **kwargs)
mul_(*args, **kwargs)
multiply(*args, **kwargs)
multiply_(*args, **kwargs)
nan_to_num(*args, **kwargs)
nan_to_num_(*args, **kwargs)
ne(*args, **kwargs)
ne_(*args, **kwargs)
neg(*args, **kwargs)
neg_(*args, **kwargs)
negative(*args, **kwargs)
negative_(*args, **kwargs)
new_empty_strided(*args, **kwargs)
nextafter(*args, **kwargs)
nextafter_(*args, **kwargs)
norm(*args, **kwargs)
not_equal(*args, **kwargs)
not_equal_(*args, **kwargs)
ones_like(*args, **kwargs)
positive(*args, **kwargs)
pow(*args, **kwargs)
pow_(*args, **kwargs)
prod(*args, **kwargs)
rad2deg(*args, **kwargs)
rad2deg_(*args, **kwargs)
reciprocal(*args, **kwargs)
reciprocal_(*args, **kwargs)
remainder(*args, **kwargs)
remainder_(*args, **kwargs)
round(*args, **kwargs)
round_(*args, **kwargs)
rsqrt(*args, **kwargs)
rsqrt_(*args, **kwargs)
select(*args, **kwargs)
select_backward(*args, **kwargs)
sgn(*args, **kwargs)
sgn_(*args, **kwargs)
sigmoid(*args, **kwargs)
sigmoid_(*args, **kwargs)
sign(*args, **kwargs)
sign_(*args, **kwargs)
signbit(*args, **kwargs)
sin(*args, **kwargs)
sin_(*args, **kwargs)
sinc(*args, **kwargs)
sinc_(*args, **kwargs)
sinh(*args, **kwargs)
sinh_(*args, **kwargs)
slice(*args, **kwargs)
slice_backward(*args, **kwargs)
softmax(*args, **kwargs)
split(*args, **kwargs)
sqrt(*args, **kwargs)
sqrt_(*args, **kwargs)
square(*args, **kwargs)
square_(*args, **kwargs)
stack(*args, **kwargs)
std(*args, **kwargs)
stride(*args, **kwargs)
sub(*args, **kwargs)
sub_(*args, **kwargs)
subtract(*args, **kwargs)
subtract_(*args, **kwargs)
sum(*args, **kwargs)
t(*args, **kwargs)
tan(*args, **kwargs)
tan_(*args, **kwargs)
tanh(*args, **kwargs)
tanh_(*args, **kwargs)
to(*args, **kwargs)
to_dense(*args, **kwargs)
to_sparse(*args, **kwargs)
to_sparse_csr(*args, **kwargs)
transpose(*args, **kwargs)
true_divide(*args, **kwargs)
true_divide_(*args, **kwargs)
trunc(*args, **kwargs)
trunc_(*args, **kwargs)
unfold(*args, **kwargs)
unfold_backward(*args, **kwargs)
unsqueeze(*args, **kwargs)
values(*args, **kwargs)
var(*args, **kwargs)
view(*args, **kwargs)

On this page

masked.MaskedTensorMaskedTensor.absMaskedTensor.abs_MaskedTensor.absoluteMaskedTensor.absolute_MaskedTensor.acosMaskedTensor.acos_MaskedTensor.acoshMaskedTensor.acosh_MaskedTensor.addMaskedTensor.add_MaskedTensor.allMaskedTensor.amaxMaskedTensor.aminMaskedTensor.angleMaskedTensor.anyMaskedTensor.arccosMaskedTensor.arccos_MaskedTensor.arccoshMaskedTensor.arccosh_MaskedTensor.arcsinMaskedTensor.arcsin_MaskedTensor.arcsinhMaskedTensor.arcsinh_MaskedTensor.arctanMaskedTensor.arctan2MaskedTensor.arctan2_MaskedTensor.arctan_MaskedTensor.arctanhMaskedTensor.arctanh_MaskedTensor.argmaxMaskedTensor.argminMaskedTensor.asinMaskedTensor.asin_MaskedTensor.asinhMaskedTensor.asinh_MaskedTensor.atanMaskedTensor.atan2MaskedTensor.atan2_MaskedTensor.atan_MaskedTensor.atanhMaskedTensor.atanh_MaskedTensor.bitwise_andMaskedTensor.bitwise_and_MaskedTensor.bitwise_left_shiftMaskedTensor.bitwise_left_shift_MaskedTensor.bitwise_notMaskedTensor.bitwise_not_MaskedTensor.bitwise_orMaskedTensor.bitwise_or_MaskedTensor.bitwise_right_shiftMaskedTensor.bitwise_right_shift_MaskedTensor.bitwise_xorMaskedTensor.bitwise_xor_MaskedTensor.catMaskedTensor.ceilMaskedTensor.ceil_MaskedTensor.clampMaskedTensor.clamp_MaskedTensor.clipMaskedTensor.clip_MaskedTensor.cloneMaskedTensor.col2imMaskedTensor.conjMaskedTensor.conj_physicalMaskedTensor.conj_physical_MaskedTensor.contiguousMaskedTensor.copy_MaskedTensor.cosMaskedTensor.cos_MaskedTensor.coshMaskedTensor.cosh_MaskedTensor.deg2radMaskedTensor.deg2rad_MaskedTensor.detachMaskedTensor.digammaMaskedTensor.digamma_MaskedTensor.divMaskedTensor.div_MaskedTensor.divideMaskedTensor.divide_MaskedTensor.eqMaskedTensor.eq_MaskedTensor.erfMaskedTensor.erf_MaskedTensor.erfcMaskedTensor.erfc_MaskedTensor.erfinvMaskedTensor.erfinv_MaskedTensor.expMaskedTensor.exp2MaskedTensor.exp2_MaskedTensor.exp_MaskedTensor.expandMaskedTensor.expm1MaskedTensor.expm1_MaskedTensor.fixMaskedTensor.fix_MaskedTensor.floorMaskedTensor.floor_MaskedTensor.floor_divideMaskedTensor.floor_divide_MaskedTensor.fmaxMaskedTensor.fminMaskedTensor.fmodMaskedTensor.fmod_MaskedTensor.fracMaskedTensor.frac_MaskedTensor.geMaskedTensor.ge_MaskedTensor.greaterMaskedTensor.greater_MaskedTensor.greater_equalMaskedTensor.greater_equal_MaskedTensor.gtMaskedTensor.gt_MaskedTensor.i0MaskedTensor.i0_MaskedTensor.im2colMaskedTensor.indexMaskedTensor.indicesMaskedTensor.is_contiguousMaskedTensor.is_same_sizeMaskedTensor.isnanMaskedTensor.itemMaskedTensor.leMaskedTensor.le_MaskedTensor.lessMaskedTensor.less_MaskedTensor.less_equalMaskedTensor.less_equal_MaskedTensor.lgammaMaskedTensor.lgamma_MaskedTensor.logMaskedTensor.log10MaskedTensor.log10_MaskedTensor.log1pMaskedTensor.log1p_MaskedTensor.log2MaskedTensor.log2_MaskedTensor.log_MaskedTensor.logaddexpMaskedTensor.logaddexp2MaskedTensor.logitMaskedTensor.logit_MaskedTensor.ltMaskedTensor.lt_MaskedTensor.maximumMaskedTensor.meanMaskedTensor.minimumMaskedTensor.mulMaskedTensor.mul_MaskedTensor.multiplyMaskedTensor.multiply_MaskedTensor.nan_to_numMaskedTensor.nan_to_num_MaskedTensor.neMaskedTensor.ne_MaskedTensor.negMaskedTensor.neg_MaskedTensor.negativeMaskedTensor.negative_MaskedTensor.new_empty_stridedMaskedTensor.nextafterMaskedTensor.nextafter_MaskedTensor.normMaskedTensor.not_equalMaskedTensor.not_equal_MaskedTensor.ones_likeMaskedTensor.positiveMaskedTensor.powMaskedTensor.pow_MaskedTensor.prodMaskedTensor.rad2degMaskedTensor.rad2deg_MaskedTensor.reciprocalMaskedTensor.reciprocal_MaskedTensor.remainderMaskedTensor.remainder_MaskedTensor.roundMaskedTensor.round_MaskedTensor.rsqrtMaskedTensor.rsqrt_MaskedTensor.selectMaskedTensor.select_backwardMaskedTensor.sgnMaskedTensor.sgn_MaskedTensor.sigmoidMaskedTensor.sigmoid_MaskedTensor.signMaskedTensor.sign_MaskedTensor.signbitMaskedTensor.sinMaskedTensor.sin_MaskedTensor.sincMaskedTensor.sinc_MaskedTensor.sinhMaskedTensor.sinh_MaskedTensor.sliceMaskedTensor.slice_backwardMaskedTensor.softmaxMaskedTensor.splitMaskedTensor.sqrtMaskedTensor.sqrt_MaskedTensor.squareMaskedTensor.square_MaskedTensor.stackMaskedTensor.stdMaskedTensor.strideMaskedTensor.subMaskedTensor.sub_MaskedTensor.subtractMaskedTensor.subtract_MaskedTensor.sumMaskedTensor.tMaskedTensor.tanMaskedTensor.tan_MaskedTensor.tanhMaskedTensor.tanh_MaskedTensor.toMaskedTensor.to_denseMaskedTensor.to_sparseMaskedTensor.to_sparse_csrMaskedTensor.transposeMaskedTensor.true_divideMaskedTensor.true_divide_MaskedTensor.truncMaskedTensor.trunc_MaskedTensor.unfoldMaskedTensor.unfold_backwardMaskedTensor.unsqueezeMaskedTensor.valuesMaskedTensor.varMaskedTensor.view
Ask DeepWiki