An open API service indexing awesome lists of open source software.

https://github.com/openethicsai/oel

This repository contains Open Ethics Label content and integration examples.
https://github.com/openethicsai/oel

ethics-compliance ethics-in-ai labeling-tool labels labels-generator

Last synced: 2 months ago
JSON representation

This repository contains Open Ethics Label content and integration examples.

Awesome Lists containing this project

README

        

# Open Ethics Label (OEL)

This repository contains Open Ethics Label content and integration examples for adding ethical transparency labels to websites and AI-powered applications. The intended use of this repository is for developers and Open Ethics network partners only.

Those willing to generate the label for their product, should directly use [this link](http://openethics.ai/label/generate/) to fill in the disclosure form.

## Repository Structure

```
.
├── examples/ # Integration examples
│ ├── disclosure form/ # Integration examples for the Disclosure Form, for partners
│ │ ├── label-demo-page.html # Demo page showing label integration
│ │ ├── oel-form.js # JavaScript for form integration, hosted on "https://openethics.ai/src/js/oel-form.js"
│ │ └── oel-iframe-snippet.html # HTML snippet for iframe embedding. The content is the same as generated by the JS file
│ └── label widget/ # Widget examples with Label rendering, for product owners
│ └── oel.html # Example label widget implementation

├── src/ # Source files
│ ├── css/ # Stylesheets for label rendering
│ ├── favicon/ # Favicon assets in various sizes
│ ├── images/ # Label SVG images and assets
│ └── js/ # JavaScript modules
│ └── functions.js # Core label rendering functions

├── .htaccess # Apache server configuration
├── index.html # Main label page for iframe rendering
└── LICENSE # MIT License
```

## Labels
Labels are the SVG images stored in `src/images/`.

## Label Structure
![Open Ethics Label Structure](docs/oel-structure.png)

## Examples
### Widget with an iframe

The label widget could be intalled by the developer by copy-pasting the generated code from `oel.html`. The code snippet that product owners will get after submitting the [disclosure form](http://openethics.ai/label/generate/) will contain the iframe sourcing content from `label.openethics.ai` based on the parameters specified in the `src` of the request.

ATTENTION: the `oel.html` in [examples/widget/oel.html](examples/widget/oel.html) is provided just as an example and product owners should obtain their own oel.html by filling in the [disclosure form](http://openethics.ai/label/generate/).

```html

```

### Partner Integration of the disclosure form
As a network partner, you can integrate the Open Ethics Label disclosure form into your website:

1. Include the label form using the JavaScript integration:

```html

initializeOpenEthicsLabelForm("YOUR_PARTNER_KEY", "YOUR_ALIAS", "#oel_form");

```

2. Or use the iframe snippet from `examples/integration/oel-iframe-snippet.html`

See the examples directory for complete integration demos.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.