Skip to content

Commit 8a5badd

Browse files
authored
Update: introduce Tyx as short name
1 parent 9fe7527 commit 8a5badd

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ computational workflows.
3232
3333
## Synopsis
3434

35-
**Uncertaintyx** is a lightweight framework for tensor‑level uncertainty
36-
propagation, fitting of empirical or physics-informed models, and
35+
**Uncertaintyx** (or just **Tyx**) is a lightweight framework for tensor‑level
36+
uncertainty propagation, fitting of empirical or physics-informed models, and
3737
metrology‑aware workflows. It produces uncertainty tensors by combining
3838
tensor‑valued models with AD backends such as [JAX](https://docs.jax.dev/).
3939
Conventional [NumPy](https://numpy.org)
@@ -81,8 +81,8 @@ f: \mathbb{R}^{k_1 \times \cdots \times k_{N_k}} \times
8181
f(p, x) \mapsto y
8282
$$
8383

84-
**Uncertaintyx** extends this formulation by introducing a batch
85-
dimension $M \in \mathbb{N}$ into the function signature:
84+
**Tyx** extends this formulation by introducing a batch dimension
85+
$M \in \mathbb{N}$ into the function signature:
8686

8787
$$
8888
f: \mathbb{R}^{k_1 \times \cdots \times k_{N_k}} \times
@@ -91,13 +91,13 @@ f: \mathbb{R}^{k_1 \times \cdots \times k_{N_k}} \times
9191
f(p, X) \mapsto Y
9292
$$
9393

94-
The main objective of Uncertaintyx is to provide efficient access
95-
to uncertainty tensors for such functions. While Jacobians themselves
94+
The main objective of **Tyx** is to provide efficient access to
95+
uncertainty tensors for such functions. While Jacobians themselves
9696
are obtained through automatic differentiation (using JAX),
97-
**Uncertaintyx** delivers a high-level interface, utilities,
98-
and structured handling for them. These Jacobians form the foundation
99-
for parameter estimation, sensitivity analysis, and uncertainty
100-
propagation within the framework.
97+
**Tyx** delivers a high-level interface, utilities, and structured
98+
handling for them. These Jacobians form the foundation for parameter
99+
estimation, sensitivity analysis, and uncertainty propagation within
100+
the framework.
101101

102102
The **single-input tensor paradigm** is lightweight and modern,
103103
following the design principles of leading machine learning frameworks.
@@ -107,12 +107,12 @@ logical inputs without cluttering the function signature. Organizing
107107
and assembling these logical inputs into a unified tensor structure is
108108
the user’s responsibility. In this role, you serve as the *Thalamus*—the
109109
interface channelling structured data into the computational core
110-
of Uncertaintyx.
110+
of **Tyx**.
111111

112112
> The batch dimension $M$ enumerates independent samples (e.g.,
113113
> sensor scans, simulations, ensemble members) but you get to define
114114
> what “one sample” is: a single pixel value, a spectrum, a scan line,
115-
> or a spatiotemporal cubelet. Uncertaintyx treats that single sample as
115+
> or a spatiotemporal cubelet. **Tyx** treats that single sample as
116116
> a tensor $x$, and the framework scales it to a batch $X$ of $M$ such
117117
> samples. Many remote‑sensing workflows implicitly assume “one sample
118118
> is one pixel”, but this is often an oversimplification that obscures

0 commit comments

Comments
 (0)