Skip to content

Commit

Permalink
Bump release to 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
lukamac committed Jan 14, 2024
1 parent c764efe commit b3ede52
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

## [Unreleased]
## [0.3.0] - 2024-01-14

### Added

Expand Down
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,35 @@ A kernel library targeting Neural Network Accelerators developed in the PULP gro

This library is considered unstable and might go through major changes until a stable release of v1.0.0.

## NNX Interface

The interface to each accelerator consists of these functions:

```c
void <accelerator>_nnx_init(<accelerator>_dev_t *dev, <accelerator>_pulp_conf_t *conf);
void <accelerator>_nnx_term(<accelerator>_dev_t *dev);
int <accelerator>_nnx_dispatch(<accelerator>_dev_t *dev, <accelerator>_task_t *task);
int <accelerator>_nnx_dispatch_check(<accelerator>_dev_t *dev);
void <accelerator>_nnx_dispatch_wait(<accelerator>_dev_t *dev);
int <accelerator>_nnx_resolve_check(<accelerator>_dev_t *dev, <accelerator>_task_t *task);
void <accelerator>_nnx_resolve_wait(<accelerator>_dev_t *dev, <accelerator>_task_t *task);
```
Each accelerator has their own named function in case there exist multiple types of accelerators on a same board.
Each function accepts a pointer to a `<accelerator>_dev_t` type which to discern between each accelerator.
_Note: The accelerator can provide additional helper functions if needed._
## Repository structure
- inc: interface to the library
- src: implementations of the interface for specific accelerators
- inc: nnx interface for each accelerator
- src: implementation for each accelerator
- util: utilities used by all the accelerators
- &lt;accelerator>:
- hal: hardware abstraction layer
- gvsoc: gvsoc-specific functions
- bsp: board support package for each board that has the accelerator
- test: testing folder ([more info](test/README.md))
## Accelerators
Expand Down

0 comments on commit b3ede52

Please sign in to comment.