maidenx 0.1.0

Rust ML Framework for Maiden Engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

# Supported Functions

Blank: Upcoming support
✓: Supported
✗: Not supported

## DType

| Data type | DType |
|---|---|
| 16-bit floating point | `maidenx::bfloat16` |
| 16-bit floating point | `maidenx::float16` or `maidenx::half` |
| 32-bit floating point | `maidenx::float32` |
| 64-bit floating point | `maidenx::float64` |
| boolean | `maidenx::bool` (only support logical operations) |
| 8-bit integer (unsigned) | `maidenx::uint8` |
| 16-bit integer (unsigned) | not supported |
| 32-bit integer (unsigned) | `maidenx::uint32` |
| 64-bit integer (unsigned) | not supported |
| 8-bit integer (signed) | `maidenx::int8` |
| 16-bit integer (signed) | not supported |
| 32-bit integer (signed) | `maidenx::int32` |
| 64-bit integer (signed) | `maidenx::int64` |

<br/>

## Tensor

### Tensor Operations

| Category | Name | Autograd | CPU | CUDA |
|---|---|---|---|---|
| **Binary Operations** |
|            | `add`              | ✓ | ✓ | ✓ |
|            | `sub`              | ✓ | ✓ | ✓ |
|            | `mul`              | ✓ | ✓ | ✓ |
|            | `div`              | ✓ | ✓ | ✓ |
| logical operations |
|            | `logical_and`      | ✗ | ✓ | ✓ |
|            | `logical_or`       | ✗ | ✓ | ✓ |
|            | `logical_xor`      | ✗ | ✓ | ✓ |
| comparison operations |
|            | `eq`               | ✗ | ✓ | ✓ |
|            | `ne`               | ✗ | ✓ | ✓ |
|            | `lt`               | ✗ | ✓ | ✓ |
|            | `le`               | ✗ | ✓ | ✓ |
|            | `gt`               | ✗ | ✓ | ✓ |
|            | `ge`               | ✗ | ✓ | ✓ |
| matrix multiplication |
|            | `matmul`           | ✓ | ✓ | ✓ |
| in-place |
|            | `add_`             | ✗ | ✓ | ✓ |
|            | `sub_`             | ✗ | ✓ | ✓ |
|            | `mul_`             | ✗ | ✓ | ✓ |
|            | `div_`             | ✗ | ✓ | ✓ |
| **Unary Operations** |
|            | `neg`              | ✓ | ✓ | ✓ |
|            | `abs`              | ✓ | ✓ | ✓ |
|            | `sign`             | ✗ | ✓ | ✓ |
|            | `square`           | ✓ | ✓ | ✓ |
|            | `sqrt`             | ✓ | ✓ | ✓ |
|            | `relu`             | ✓ | ✓ | ✓ |
|            | `sigmoid`          | ✓ | ✓ | ✓ |
|            | `tanh`             | ✓ | ✓ | ✓ |
| logical operations |
|            | `logical_not`      | ✗ | ✓ | ✓ |
| with constant |
|            | `add_scalar`       | ✓ | ✓ | ✓ |
|            | `sub_scalar`       | ✓ | ✓ | ✓ |
|            | `mul_scalar`       | ✓ | ✓ | ✓ |
|            | `div_scalar`       | ✓ | ✓ | ✓ |
|            | `pow`              | ✓ | ✓ | ✓ |
| comparison operations |
|            | `eq_scalar`        | ✗ | ✓ | ✓ |
|            | `ne_scalar`        | ✗ | ✓ | ✓ |
|            | `lt_scalar`        | ✗ | ✓ | ✓ |
|            | `le_scalar`        | ✗ | ✓ | ✓ |
|            | `gt_scalar`        | ✗ | ✓ | ✓ |
|            | `ge_scalar`        | ✗ | ✓ | ✓ |
| **Reduction Operations** |
|            | `sum`              | ✓ | ✓ | ✓ |
|            | `sum_all`          | ✓ | ✓ | ✓ |
|            | `sum_to_shape`     | ✓ | ✓ | ✓ |
|            | `mean`             | ✓ | ✓ | ✓ |
|            | `mean_all`         | ✓ | ✓ | ✓ |
| **Transform Operations** |
| view operations |
|            | `view`             | ✓ | ✓ | ✓ |
|            | `squeeze`          | ✓ | ✓ | ✓ |
|            | `squeeze_all`      | ✓ | ✓ | ✓ |
|            | `unsqueeze`        | ✓ | ✓ | ✓ |
|            | `transpose`        | ✓ | ✓ | ✓ |
| reshape operations |
|            | `reshape`          | ✓ | ✓ | ✓ |
|            | `broadcast`        | ✓ | ✓ | ✓ |
|            | `broadcast_left`   | ✓ | ✓ | ✓ |

<br/>

### Tensor Functions

| Category | Name | CPU | CUDA |
|---|---|---|---|
| **Util Functions** |
|            | `is_contiguous`    | ✓ | ✓ |
|            | `contiguous`       | ✓ | ✓ |

<br/>

## Neural Networks

### Layers

| Category | Name | CPU | CUDA |
|---|---|---|---|
| **Linear Layers** |
|            | `Linear`           | ✓ | ✓ |
| **Convolution Layers** |
|            | `Conv2d`           | ✓ | ✓ |
| **Functional Layers** |
|            | `ReLU`             | ✓ | ✓ |
|            | `Sigmoid`          | ✓ | ✓ |
|            | `Tanh`             | ✓ | ✓ |

<br/>

### Loss Layers

| Category | Name | CPU | CUDA |
|---|---|---|---|
|            | `Huber`            | ✓ | ✓ |
|            | `MAE`              | ✓ | ✓ |
|            | `MSE`              | ✓ | ✓ |

<br/>

### Optimizer

| Category | Name | CPU | CUDA |
|---|---|---|---|
|            | `Adam`             | ✓ | ✓ |
|            | `SGD`              | ✓ | ✓ |