semvec/pypi-packages huggingface dataset:
nndesigndemos 1.1.6
Demos for the Neural Network Design & Deep Learning books
License: MIT
Requires Python: >=3.9

# nndesigndemos

This is a set of demonstrations paired with the [Neural Network Design](https://hagan.okstate.edu/nnd.html) 
& Neural Network Design: Deep Learning books written in Python.

## Installation

nndesigndemos is supported on macOS, Linux and Windows. It uses PyQt6, so your OS version needs to be compatible with it.
 If you get an installation error, this is most likely the reason.

* For **Linux** platform, if you meet the following or similar problems when you install the nndesigndemos or run the code after installing it:
 
     ```
     qt.qpa.plugin: Could not load the Qt platform plugin "xcb" in "" even though it was found.
     This application failed to start because no Qt platform plugin could be initialized. Reinstalling the application may fix this problem.
     
     Available platform plugins are: eglfs, offscreen, wayland, wayland-egl, linuxfb, minimal, xcb, minimalegl, vkkhrdisplay, vnc.
     
     Aborted (core dumped)
     ```

    you need to install a plugin first using command line:

   ```
   sudo apt-get install -y libxcb-cursor-dev
   ```

* Sometime for **macOS** or **Linux** platform, we may need this package as well:
   ```
   sudo apt-get install pulseaudio
   ```

### Installing via pip

The quick way is simply to install via `pip install nndesigndemos`, which works in most cases.

The recommended way is to create a virtual environment to avoid dependency issues. Here is an easy way to do so:

```
python3 -m venv env
source env/bin/activate  # macOS/Linux
env\Scripts\activate.bat  # Windows
pip install nndesigndemos
```

To deactivate the virtual environment, just type `deactivate`.

## Usage

All the demos start from the same main menu, which can be accessed by entering the Python Shell and running

```
from nndesigndemos import nndtoc
nndtoc()
```

After doing so, a window will pop up, and you will be able to navigate the demos listed by book and then by chapter.

There are some demos that have sound, so if you want to mute them just run `nndtoc(play_sound=False)` instead.

The original software for these demos runs on MATLAB, so for every section of the 
[Neural Network Design](https://hagan.okstate.edu/NNDesign.pdf) book where you see the MATLAB logo, 
there will be a corresponding Python demo in this package. The second book is in progress.

If you are using multiple monitors and switching between them, you may need to restart your computer to avoid scaling issues.

## Dependencies

These are the packages needed to run all the demos. These specific versions are known to work, but this does not mean 
older or newer versions will cause any issues.

- Python 3.9+
- PyQt6 6.7.1
- NumPy 2.0.1
- SciPy 1.13.1
- Matplotlib 3.9.2

## License

nndesigndemos is available under MIT license.