Skip to content

Commit 26d06a7

Browse files
authored
chore: add shuffling to readme and bump version (#71)
1 parent 2af49a0 commit 26d06a7

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,29 @@
77
## Features
88

99
### Use Numpy Array Features
10+
1011
- **Dot Product**: Compute the dot product between two NadaArray objects.
1112
- **Element-wise Operations**: Perform element-wise addition, subtraction, multiplication, and division with broadcasting support.
1213
- **Stacking**: Horizontally and vertically stack arrays.
14+
15+
### Use additional Array helpers
16+
17+
- **Shuffling**: Our implementation shuffles a 1D array using the Benes network, which rearranges elements in a deterministic yet seemingly random order. The Benes network is commonly used in sorting and switching circuits and requires the input array length to be a power of two (e.g., 2, 4, 8, 16). The shuffled array contains the same elements as the input, just in a different order.
18+
1319
### Use Decimal Numbers in Nada
20+
1421
- **Rational Number Support**: Our implementation of `Rational` and `SecretRational` allows the use of simplified implementations of decimal numbers on top of Nillion.
1522

1623
## Installation
24+
1725
### Using pip
1826

1927
```bash
2028
pip install nada-numpy
2129
```
2230

2331
### From Sources
32+
2433
You can install the nada-numpy library using Poetry:
2534

2635
```bash
@@ -45,4 +54,4 @@ See the [CONTRIBUTING](./CONTRIBUTING.md) file for how to contribute to `nada-nu
4554

4655
## License
4756

48-
This project is licensed under the Apache2 License. See the LICENSE file for details.
57+
This project is licensed under the Apache2 License. See the LICENSE file for details.

poetry.lock

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "nada-numpy"
3-
version = "0.5.0"
3+
version = "0.5.1"
44
description = "Nada-Numpy is a Python library designed for algebraic operations on NumPy-like array objects on top of Nada DSL and Nillion Network."
55
authors = ["José Cabrero-Holgueras <jose.cabrero@nillion.com>"]
66
readme = "README.md"

0 commit comments

Comments
 (0)