Skip to content

Commit

Permalink
fix:license tests (#6)
Browse files Browse the repository at this point in the history
* fix:license tests

* fix:license tests
  • Loading branch information
JarbasAl authored Oct 15, 2024
1 parent 91c221d commit f5f31be
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/license_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
requirements: 'requirements-all.txt'
fail: 'Copyleft,Other,Error'
fails-only: true
exclude: '^(tqdm).*'
exclude: '^(fann2|tqdm).*'
exclude-license: '^(Mozilla).*$'
- name: Print report
if: ${{ always() }}
Expand Down
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE.md)
# Padatious

An efficient and agile neural network intent parser.
An efficient and agile neural network intent parser powered by [fann](https://github.com/libfann/fann).

This repository contains a OVOS pipeline plugin and bundles a fork of the original [padatious](https://github.com/MycroftAI/padatious) from the defunct MycroftAI


## Features

- Intents are easy to create
Expand All @@ -14,7 +13,6 @@ This repository contains a OVOS pipeline plugin and bundles a fork of the origin
- Easily extract entities (ie. Find the nearest *gas station* -> `place: gas station`)
- Fast training with a modular approach to neural networks

## Getting Started

### Installing

Expand All @@ -38,15 +36,10 @@ pip3 install padatious
```
Padatious also works in Python 2 if you are unable to upgrade.


[fann]:https://github.com/libfann/fann

### Example
### Direct Usage

Here's a simple example of how to use Padatious:

#### program.py

```Python
from ovos_padatious import IntentContainer

Expand All @@ -62,3 +55,8 @@ print(container.calc_intent('Search for cats on CatTube.'))
container.remove_intent('goodbye')
```

### License

> **NOTE**: This plugin is an exception to [OVOS universal donor policy](https://openvoiceos.github.io/ovos-technical-manual/license/)
It is licensed under the Apache 2 license, however it depends on fann2 which is licensed under the LGPL. [Why is this an issue?](https://softwareengineering.stackexchange.com/questions/119436/what-does-gpl-with-classpath-exception-mean-in-practice/326325#326325)

0 comments on commit f5f31be

Please sign in to comment.