Skip to content

Commit

Permalink
chore: add shuffling to readme and bump version (#71)
Browse files Browse the repository at this point in the history
  • Loading branch information
oceans404 authored Sep 4, 2024
1 parent 2af49a0 commit 26d06a7
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 5 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,29 @@
## Features

### Use Numpy Array Features

- **Dot Product**: Compute the dot product between two NadaArray objects.
- **Element-wise Operations**: Perform element-wise addition, subtraction, multiplication, and division with broadcasting support.
- **Stacking**: Horizontally and vertically stack arrays.

### Use additional Array helpers

- **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.

### Use Decimal Numbers in Nada

- **Rational Number Support**: Our implementation of `Rational` and `SecretRational` allows the use of simplified implementations of decimal numbers on top of Nillion.

## Installation

### Using pip

```bash
pip install nada-numpy
```

### From Sources

You can install the nada-numpy library using Poetry:

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

## License

This project is licensed under the Apache2 License. See the LICENSE file for details.
This project is licensed under the Apache2 License. See the LICENSE file for details.
6 changes: 3 additions & 3 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "nada-numpy"
version = "0.5.0"
version = "0.5.1"
description = "Nada-Numpy is a Python library designed for algebraic operations on NumPy-like array objects on top of Nada DSL and Nillion Network."
authors = ["José Cabrero-Holgueras <[email protected]>"]
readme = "README.md"
Expand Down

0 comments on commit 26d06a7

Please sign in to comment.