API Reference - krishanth7/EveryO GitHub Wiki
Build · Compute · Differentiate · Train · Integrate
A centralized reference for EveryO's public Python interfaces, computational functions, neural network components, optimization algorithms, data utilities, training tools, and integrations.
Home · Quick Start · Framework Architecture · Examples and Tutorials
Maintained By & Owner: EveryO Contributors & @krishanth7
Important
API Version and Compatibility
This reference is based on the public exports declared in everyo/__init__.py for the repository's default branch, with package metadata reporting version 0.2.0.
EveryO is currently classified as alpha software. APIs may change.
Public symbol availability has been checked against source exports. Detailed signatures are provided only where inspected; for other APIs, use Python introspection and the linked source code to confirm parameters and behavior.
- API Overview
- Installation and Import
- Package Structure
- Tensor API
- Tensor Creation
- Mathematical Operations
- Automatic Differentiation
- Neural Network API
- Optimization API
- Data Processing API
- Training API
- Backend and Device API
- Mixed Precision API
- Serialization and ONNX
- Quantization API
- Profiling and Visualization
- Configuration and Logging
- Exceptions
- API Inspection and Compatibility
- Developer References
- Next Steps
EveryO exposes a Python interface for neural computing and machine learning experimentation.
Its public exports cover tensor operations, gradient tracking, neural network modules, optimizers, data utilities, training workflows, serialization, and optional integrations.
| Category | Main Responsibility |
|---|---|
| Core | Tensor structures and numerical operations |
| Autograd | Gradient tracking and differentiation |
| Neural Networks | Layers, models, losses, activations |
| Optimization | Parameter updates |
| Data | Datasets, loading, preprocessing |
| Training | Training loops, callbacks, metrics |
| Backends | Numerical execution and device integration |
| Precision | Mixed-precision execution utilities |
| Serialization | Saving, loading, ONNX interoperability |
| Quantization | Reduced-precision representations |
| Profiling | Performance inspection |
| Visualization | Training and evaluation plots |
| Configuration | Application and training configuration |
import everyo as eoThe eo alias is used throughout this reference.
| Requirement | Version |
|---|---|
| Python | 3.9 or newer |
| NumPy | 1.22 or newer |
| Matplotlib | 3.5 or newer |
git clone https://github.com/krishanth7/EveryO.git
cd EveryO
python -m pip install -e .The repository declares these optional dependency groups:
| Extra | Purpose |
|---|---|
dev |
Development and testing |
tensorflow |
TensorFlow integration |
cuda |
CUDA extension build dependencies |
onnx |
ONNX export and runtime |
yaml |
YAML configuration |
Example:
python -m pip install -e ".[dev]"import everyo as eo
print(eo.__version__)EveryO organizes functionality across several Python modules.
everyo
|
+-- core
| +-- tensor
| +-- operations
| +-- autograd
| +-- device
| +-- dtype
| +-- convolution
|
+-- nn
|
+-- optim
|
+-- data
|
+-- training
|
+-- backends
|
+-- cuda
|
+-- precision
|
+-- serialization
|
+-- quantization
|
+-- profiler
|
+-- visualization
|
+-- config
This is a simplified functional map, not an exhaustive directory listing.
The public API is defined by the exports in:
Developers can inspect available symbols using:
import everyo as eo
for name in eo.__all__:
print(name)The Tensor class represents multidimensional numerical data with optional gradient tracking.
| API | Description |
|---|---|
Tensor |
Tensor class |
tensor |
Tensor construction |
as_tensor |
Convert supported input to tensor |
is_tensor |
Tensor type check |
The source defines the following constructor:
Tensor(
data,
*,
dtype=None,
device="cpu",
requires_grad=False,
name=None
)| Parameter | Type / Concept | Description |
|---|---|---|
data |
Array-like or scalar | Input numerical data |
dtype |
Optional | Requested data type |
device |
Device-like | Execution device |
requires_grad |
Boolean | Enable gradient tracking |
name |
Optional string | Debugging label |
import everyo as eo
x = eo.tensor([
[1.0, 2.0],
[3.0, 4.0]
])
print(x.shape)Expected output:
(2, 2)
The Tensor implementation exposes data and shape information.
import everyo as eo
x = eo.tensor([1.0, 2.0, 3.0])
print(x.shape)
print(x.data)import everyo as eo
x = eo.tensor([[1.0, 2.0]])
y = eo.tensor([[3.0], [4.0]])
result = eo.matmul(x, y)
print(result.item())Expected output:
11.0
Source: Tensor Implementation
EveryO publicly exports the following tensor creation functions.
| Function | General Purpose |
|---|---|
tensor |
Create a tensor |
as_tensor |
Convert input to tensor |
zeros |
Create zero-filled tensor |
ones |
Create one-filled tensor |
full |
Create tensor with a specified fill value |
eye |
Create identity-style matrix |
arange |
Create a numeric sequence |
linspace |
Create evenly spaced values |
rand |
Generate random values |
randn |
Generate normally distributed values |
normal |
Normal-distribution generation |
uniform |
Uniform-distribution generation |
zeros_like |
Create zeros based on another tensor |
ones_like |
Create ones based on another tensor |
import everyo as eo
x = eo.zeros(3, 4)
print(x.shape)import everyo as eo
identity = eo.eye(3)
print(identity.data)Note
Inspect the signatures of creation functions before passing optional parameters such as dtype, device, or random seeds.
EveryO exposes mathematical functions through its top-level namespace.
| Function | Operation |
|---|---|
add |
Addition |
subtract |
Subtraction |
multiply |
Multiplication |
divide |
Division |
negative |
Negation |
power |
Exponentiation |
abs |
Absolute value |
clip |
Value clipping |
| Function | Operation |
|---|---|
matmul |
Matrix multiplication |
dot |
Dot product |
| Function | Operation |
|---|---|
exp |
Exponential |
log |
Natural logarithm |
sqrt |
Square root |
sigmoid |
Sigmoid |
tanh |
Hyperbolic tangent |
relu |
ReLU |
softmax |
Softmax |
log_softmax |
Log-softmax |
| Function | Operation |
|---|---|
sum |
Sum |
mean |
Mean |
max |
Maximum |
min |
Minimum |
variance |
Variance |
| Function | Operation |
|---|---|
reshape |
Reshape |
transpose |
Transpose |
flatten |
Flatten |
concatenate |
Concatenate |
stack |
Stack tensors |
| Function | Purpose |
|---|---|
one_hot |
One-hot representation |
conv2d |
Two-dimensional convolution |
max_pool2d |
Max pooling |
avg_pool2d |
Average pooling |
EveryO exports gradient-control utilities.
| API | Purpose |
|---|---|
no_grad |
Disable gradient tracking within a context |
enable_grad |
Enable gradient tracking within a context |
set_grad_enabled |
Control gradient tracking |
import everyo as eo
x = eo.tensor(
[1.0, 2.0, 3.0],
requires_grad=True
)import everyo as eo
with eo.no_grad():
x = eo.tensor([1.0, 2.0, 3.0])
y = eo.multiply(x, x)The autograd system is concerned with:
- Computational dependencies.
- Backward propagation.
- Gradient accumulation.
- Differentiable tensor operations.
- Gradient-tracking state.
Related Documentation: Automatic Differentiation
EveryO exports neural network components from everyo.nn.
| Class | Purpose |
|---|---|
Module |
Base neural network module |
Parameter |
Trainable parameter |
Sequential |
Sequential model composition |
| Class | Purpose |
|---|---|
Linear |
Fully connected layer |
Flatten |
Flatten dimensions |
Dropout |
Dropout regularization |
Embedding |
Embedding representation |
| Class | Purpose |
|---|---|
Conv2D |
Two-dimensional convolution |
MaxPool2D |
Maximum pooling |
AvgPool2D |
Average pooling |
BatchNorm1D |
One-dimensional batch normalization |
BatchNorm2D |
Two-dimensional batch normalization |
LayerNorm |
Layer normalization |
| Class | Purpose |
|---|---|
ReLU |
ReLU activation |
Sigmoid |
Sigmoid activation |
Tanh |
Tanh activation |
Softmax |
Softmax |
LogSoftmax |
Log-softmax |
| Class | Purpose |
|---|---|
RNN |
Recurrent neural network |
LSTM |
Long Short-Term Memory |
GRU |
Gated Recurrent Unit |
| API | Purpose |
|---|---|
MultiHeadAttention |
Multi-head attention |
PositionalEncoding |
Positional representations |
TransformerEncoderBlock |
Transformer encoder block |
TransformerEncoder |
Transformer encoder |
scaled_dot_product_attention |
Attention computation |
causal_mask |
Causal masking |
padding_mask |
Padding masking |
| Class | General Use |
|---|---|
Loss |
Base loss abstraction |
MSELoss |
Mean squared error |
MAELoss |
Mean absolute error |
BCELoss |
Binary cross-entropy |
BCEWithLogitsLoss |
Binary cross-entropy with logits |
CrossEntropyLoss |
Classification cross-entropy |
Linear(
in_features,
out_features,
*,
bias=True,
initializer="he_uniform",
seed=None
)| Parameter | Description |
|---|---|
in_features |
Input feature count |
out_features |
Output feature count |
bias |
Whether to include trainable bias |
initializer |
Weight initialization scheme |
seed |
Optional initialization seed |
import everyo as eo
layer = eo.Linear(4, 2, seed=0)
x = eo.zeros(3, 4)
output = layer(x)
print(output.shape)Expected output:
(3, 2)
Source: Neural Network Layers
EveryO exports the following optimizer classes.
| Class | Purpose |
|---|---|
Optimizer |
Optimizer base class |
SGD |
Stochastic Gradient Descent |
Adam |
Adaptive Moment Estimation |
from everyo import SGD, AdamA typical optimization process includes:
- Model parameter initialization.
- Forward computation.
- Loss calculation.
- Gradient calculation.
- Parameter updates.
Inspect exact optimizer signatures using:
import inspect
import everyo as eo
print(inspect.signature(eo.SGD))
print(inspect.signature(eo.Adam))Do not assume that optimizer parameter names or defaults match those of another machine learning framework.
Related Documentation: Optimization
EveryO exports dataset and preprocessing utilities.
| API | Purpose |
|---|---|
Dataset |
Dataset abstraction |
ArrayDataset |
Array-backed dataset |
TransformDataset |
Transformed dataset |
Subset |
Dataset subset |
DataLoader |
Data loading |
| Function | Purpose |
|---|---|
train_test_split |
Split training and test data |
stratified_split |
Stratified splitting |
random_split |
Random splitting |
| API | Purpose |
|---|---|
StandardScaler |
Feature standardization |
MinMaxScaler |
Min-max scaling |
standardize |
Standardization |
one_hot_encode |
One-hot encoding |
load_csv_dataset |
CSV dataset loading |
import inspect
import everyo as eo
print(inspect.signature(eo.DataLoader))EveryO exports model training utilities and callbacks.
| API | Purpose |
|---|---|
Trainer |
Training workflow |
History |
Training history |
Callback |
Callback base |
EarlyStopping |
Early stopping |
ModelCheckpoint |
Model checkpointing |
LearningRateScheduler |
Learning-rate scheduling |
CSVLogger |
CSV logging |
ProgressLogger |
Progress reporting |
| API | Purpose |
|---|---|
accuracy |
Accuracy metric |
confusion_matrix |
Confusion matrix |
import inspect
import everyo as eo
print(inspect.signature(eo.Trainer))Developers should confirm:
- Callback lifecycle methods.
- Training state passed to callbacks.
- Checkpoint storage behavior.
- Scheduler update frequency.
- Exception handling.
| API | Purpose |
|---|---|
Device |
Device representation |
device |
Device-related interface |
DTYPES |
Supported dtype registry |
dtype_name |
Data type naming |
EveryO publicly exposes:
import everyo as eo
print(eo.backends)
print(eo.cuda)Device behavior depends on:
- Available hardware.
- Installed dependencies.
- Backend implementation.
- Supported operations.
- Runtime configuration.
Warning
CUDA availability must be verified independently. The presence of the cuda module does not guarantee an operational GPU backend.
EveryO exports mixed-precision utilities.
| API | Purpose |
|---|---|
autocast |
Autocast context |
autocast_dtype |
Autocast dtype information |
is_autocast_enabled |
Autocast state inspection |
GradScaler |
Gradient scaling |
Mixed precision can reduce memory usage and improve performance on suitable hardware.
However, numerical behavior depends on:
- Data type.
- Supported operations.
- Hardware.
- Loss scaling.
- Backend implementation.
import inspect
import everyo as eo
print(inspect.signature(eo.autocast))
print(inspect.signature(eo.GradScaler))EveryO exports model serialization and interoperability utilities.
| API | Purpose |
|---|---|
save |
Save supported state |
load |
Load supported state |
inspect_archive |
Inspect serialized archive |
| API | Purpose |
|---|---|
export_onnx |
ONNX export |
export_onnx_traced |
Traced ONNX export |
onnx_available |
ONNX dependency availability |
run_onnx |
ONNX execution |
trace_operations |
Operation tracing |
TRACEABLE_OPERATIONS |
Traceable operation registry |
python -m pip install -e ".[onnx]"Not all models or operations are necessarily supported by the ONNX export paths.
Confirm supported:
- Operators.
- Input shapes.
- Model architectures.
- ONNX versions.
- Runtime dependencies.
Treat untrusted serialized artifacts as potentially unsafe.
Do not assume that a file is safe merely because it has a recognized extension.
EveryO publicly exports quantization-related utilities.
| API | Purpose |
|---|---|
quantize |
Quantization operation |
quantize_dynamic |
Dynamic quantization |
QuantizedArray |
Quantized array representation |
QuantizedLinear |
Quantized linear component |
QuantizationError |
Quantization-specific error |
Quantization may help reduce:
- Model storage requirements.
- Numerical representation size.
- Memory bandwidth requirements.
Performance benefits depend on the implementation and execution hardware.
Inspect signatures before use:
import inspect
import everyo as eo
print(inspect.signature(eo.quantize))
print(inspect.signature(eo.quantize_dynamic))| API | Purpose |
|---|---|
Profiler |
Profiling component |
profile |
Profiling utility |
record_function |
Named profiling region |
| Function | Purpose |
|---|---|
plot_loss |
Loss visualization |
plot_accuracy |
Accuracy visualization |
plot_history |
Training history |
plot_predictions |
Prediction visualization |
plot_confusion_matrix |
Confusion matrix |
plot_benchmark |
Benchmark visualization |
import everyo as eo
plotter = eo.plot_loss
print(plotter)Check function signatures before passing training data or plotting options.
| API | Purpose |
|---|---|
Config |
General configuration |
DeviceConfig |
Device configuration |
ModelConfig |
Model configuration |
TrainingConfig |
Training configuration |
load_config |
Configuration loading |
| API | Purpose |
|---|---|
configure_logging |
Logging configuration |
get_logger |
Logger retrieval |
import inspect
import everyo as eo
print(inspect.signature(eo.Config))
print(inspect.signature(eo.TrainingConfig))- Validate required values.
- Document defaults.
- Avoid storing secrets in source control.
- Record reproducibility-related settings.
- Keep environment-specific configuration separate.
EveryO defines custom exception classes.
| Exception | Category |
|---|---|
EveryOError |
General framework error |
EveryOBackendError |
Backend-related error |
EveryOConfigurationError |
Configuration error |
EveryOCudaError |
CUDA-related error |
EveryODeviceError |
Device-related error |
EveryODTypeError |
Data type error |
EveryOGradientError |
Gradient-related error |
EveryOSerializationError |
Serialization error |
EveryOShapeError |
Tensor shape error |
import everyo as eo
try:
layer = eo.Linear(0, 4)
except eo.EveryOShapeError as error:
print("Invalid layer shape:", error)The Linear implementation rejects non-positive feature counts.
- Catch specific exception classes.
- Preserve useful diagnostic information.
- Avoid silently ignoring failed operations.
- Log unexpected errors.
- Validate inputs before expensive computations.
Because EveryO is in alpha development, API introspection is an important part of integration.
import everyo as eo
for name in sorted(eo.__all__):
print(name)import inspect
import everyo as eo
for name in ["tensor", "matmul", "Linear", "SGD", "Adam"]:
obj = getattr(eo, name)
try:
signature = inspect.signature(obj)
except (TypeError, ValueError):
signature = "Signature unavailable"
print(f"{name}: {signature}")import everyo as eo
help(eo.Tensor)
help(eo.Linear)
help(eo.Adam)Until a formal stability guarantee is published:
- Avoid assuming long-term signature stability.
- Pin a tested release or commit.
- Run integration tests after upgrades.
- Review the changelog.
- Report regressions through GitHub Issues.
Each detailed API entry should include:
| Field | Description |
|---|---|
| Symbol | Public class or function |
| Import Path | Supported import |
| Signature | Exact callable signature |
| Parameters | Names, types, defaults |
| Returns | Return type and meaning |
| Exceptions | Documented failure cases |
| Example | Tested executable example |
| Compatibility | Version and backend requirements |
| Source | Link to implementation |
| Resource | Link |
|---|---|
| Public API Exports | everyo/init.py |
| Tensor Implementation | core/tensor.py |
| Core Operations | core/operations.py |
| Neural Network Modules | nn/ |
| Optimizers | optim/ |
| Training | training/ |
| Examples | examples/ |
| Tests | tests/ |
| Package Configuration | pyproject.toml |
| Changelog | CHANGELOG.md |
Continue with the following EveryO Wiki pages.
| Page | Focus |
|---|---|
| Examples and Tutorials | Practical executable workflows |
| Tensor Engine | Tensor operations and numerical computing |
| Automatic Differentiation | Gradient computation |
| Neural Networks | Model development |
| Optimization | Optimizers and training |
| Backend System | Numerical execution |
Wiki links become active when their corresponding pages are created.
Next Recommended Page: Examples and Tutorials →
Home · Quick Start · Framework Architecture · Backend System
EveryO — Open Machine Learning. Built for Developers.
Maintained By & Owner:
EveryO Contributors & @krishanth7
Open Source · MIT Licensed · Community Driven
© 2026 EveryO Contributors