Skip to main content

Simple neural network interface including pre-trained model for the Kaggle Titanic dataset

Project description

Titanicbc

Titanicbc is a simple interface for training neural networks with custom hyper-parameters. The current version allows training a binary classifier network for the famous Kaggle Titanic dataset.

The aim of this package is to allow those with little or no neural network coding experience to learn how different hyper-parameter combinations affect neural network training. The package also includes a pre-trained neural network for demonstrating how networks make predictions once trained.

Later versions will expand the package to contain more flexible interfaces and networks for other classic datasets, including image and text datasets with convolutional and recurrent neural networks.

Installation

You can install Titanicbc from PyPI


pip install Titanicbc


How to use


Titanicbc provides a simple interface for training and using pre-trained networks via the config.yaml file.

The config.yaml file is included in the Python site-packages folder for Titanicbc. To find the python site-packages on your machine run python -m site from the command line or terminal and follow the path given by USER-SITE.

Once hyper-parameters have been set using config.yaml, simply run python -m Titanicbc from the command line or terminal to train a network or make predictions (depending on the value of train_new in config.yaml). The predictions made by the new or existing model will be saved into the same location in site-packages/Titanicbc as output.csv.


The options for config.yaml are presented below in the following format;

option number. Key (value options)

  1. train_new (True, False) - If true, a new neural network will be trained and overwrite trained_model.pth. If False the model parameters saved in trained_model.pth will be loaded and used for predictions.

  2. hidden_dim (Integer) - Number of neurons in each of the 3 hidden layers within the network.

  3. num_epochs (Integer) - Number of passes the network will make over the training data when training a new model.

  4. learning_rate (float) - Parameter multiplied to the weight updates during stochastic gradient descent. Currently only the Adam optimiser is used.

  5. weight_init (uniform, xavier) - Tells the network which type of initialisation to use for the model weights. Xavier is currently recommended


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Titanicbc-1.0.0.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

Titanicbc-1.0.0-py3-none-any.whl (42.7 kB view details)

Uploaded Python 3

File details

Details for the file Titanicbc-1.0.0.tar.gz.

File metadata

  • Download URL: Titanicbc-1.0.0.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for Titanicbc-1.0.0.tar.gz
Algorithm Hash digest
SHA256 08c56a7d92fcb148c1f57d8323238a008657f27399598da76bbee1a30caefcc2
MD5 6fd3a7e370c76a070aad3c944cbafe58
BLAKE2b-256 368489e77c7e237a0e3f696a00d08c6a2a5373bbb4a001b834e384c3822f1f4a

See more details on using hashes here.

File details

Details for the file Titanicbc-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: Titanicbc-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 42.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for Titanicbc-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c8e0e5a9c046e668f3a705a8a3c33f2b26153832891fe07c2f43aa81798ce2fc
MD5 2f80ec204afa4bb6a9829a53686c2f91
BLAKE2b-256 7d241babae2b7c53cd568fa9d63509fded8d05debf474602befac0d8fd149c7b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page