@webwriter/neural-network/README.md

Deep learning visualization for feed-forward networks with custom datasets, training and prediction.

# Neural Network (`@webwriter/neural-network@1.1.5`)
[License: MIT](LICENSE) | Version: 1.1.5

Deep learning visualization for feed-forward networks with custom datasets, training and prediction.

## Snippets
[Snippets](https://webwriter.app/docs/snippets/snippets/) are examples and templates using the package's widgets.

| Name | Import Path |
| :--: | :---------: |
| Pima Indians Diabetes | `@webwriter/neural-network/snippets/Pima-Indians-Diabetes.html` |
| Boston House Pricing | `@webwriter/neural-network/snippets/Boston-House-Pricing.html` |



## `NeuralNetwork` (`<webwriter-neural-network>`)


### Usage

Use with a CDN (e.g. [jsdelivr](https://jsdelivr.com)):
```html
<link href="https://cdn.jsdelivr.net/npm/@webwriter/neural-network/widgets/webwriter-neural-network.css" rel="stylesheet">
<script type="module" src="https://cdn.jsdelivr.net/npm/@webwriter/neural-network/widgets/webwriter-neural-network.js"></script>
<webwriter-neural-network></webwriter-neural-network>
```

Or use with a bundler (e.g. [Vite](https://vite.dev)):

```
npm install @webwriter/neural-network
```

```html
<link href="@webwriter/neural-network/widgets/webwriter-neural-network.css" rel="stylesheet">
<script type="module" src="@webwriter/neural-network/widgets/webwriter-neural-network.js"></script>
<webwriter-neural-network></webwriter-neural-network>
```

## Fields
| Name (Attribute Name) | Type | Description | Default | Reflects |
| :-------------------: | :--: | :---------: | :-----: | :------: |
| `setupStatus` | `SetupStatus` | Setup state of the widget. | - | ✗ |
| `editable` (`editable`) | `boolean` | Whether editing is enabled. | - | ✓ |
| `settings` (`settings`) | `Settings` | Application settings. | - | ✓ |
| `qAndA` (`qAndA`) | `QAndAEntry[]` | Help/Q&A content. | - | ✓ |
| `canvas` | `CCanvas` | Canvas instance created by the canvas-area. | - | ✗ |
| `network` | `CNetwork` | Network instance. | - | ✗ |
| `layerConfs` (`layerConfs`) | `CLayerConf[]` | Layer configuration list. | - | ✓ |
| `layerConnectionConfs` (`layerConnectionConfs`) | `CLayerConnectionConf[]` | Layer connection configuration list between layers. | - | ✓ |
| `dataSet` (`dataSet`) | `DataSet` | Active dataset. | - | ✓ |
| `availableDataSets` (`availableDataSets`) | `DataSet[]` | Available datasets. | - | ✓ |
| `trainOptions` (`trainOptions`) | `TrainOptions` | Training options. | - | ✓ |
| `modelConf` | `ModelConf` | Current model configuration. | - | ✗ |
| `selected` | `Selected` | Current multi-selection state. | - | ✗ |
| `selectedEle` | `SelectedEle` | Current single selected element. | - | ✗ |
| `panel` | `boolean` | Whether the right panel is open. | - | ✗ |
| `theme` | `Theme` | Active theme object with style string. | - | ✗ |

*Fields including [properties](https://developer.mozilla.org/en-US/docs/Glossary/Property/JavaScript) and [attributes](https://developer.mozilla.org/en-US/docs/Glossary/Attribute) define the current state of the widget and offer customization options.*

## Events
| Name | Description |
| :--: | :---------: |
| focus | - |

*[Events](https://developer.mozilla.org/en-US/docs/Web/Events) are dispatched by the widget after certain triggers.*

## Custom CSS properties
| Name | Description |
| :--: | :---------: |
| --sl-color-neutral-0 | Host background color (forwarded from Shoelace). |
| --sl-color-neutral-50 | Divider color (forwarded from Shoelace). |

*[Custom CSS properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_cascading_variables/Using_CSS_custom_properties) offer defined customization of the widget's style.*

## Editing config
| Name | Value |
| :--: | :---------: |


*The [editing config](https://webwriter.app/docs/packages/configuring/#editingconfig) defines how explorable authoring tools such as [WebWriter](https://webwriter.app) treat the widget.*

*No public methods, slots, or CSS parts.*


---
*Generated with @webwriter/build@1.9.1*