diff --git a/README.md b/README.md index 8df6c53..f3baf15 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Geonosis -Geonosis is a transformer-based autoencoder built to perform both classification (without the decoder portion) and synthetic data generation (with the decoder portion). It is named after [Geonosis](https://starwars.fandom.com/wiki/Geonosis), a planet in Star Wars franchise where the droids were manufactured. +Geonosis is a transformer-based autoencoder built to perform both classification (without the encoder only), synthetic data generation (with decoder only), or noise reduction (encoder-decoder paired). It is named after [Geonosis](https://starwars.fandom.com/wiki/Geonosis), a planet in Star Wars franchise where the droids were manufactured. ## Setting up @@ -15,8 +15,17 @@ To enter the docker container, run `launch.sh` for Linux or `winlaunch.ps1` for Windows. Once inside, change directory to `/app/code` and run the desired script. -Inputs: -.mat files in the file dump +### Encoding +Required Inputs: +.mat files in the matfiles directory, .hdf5 file in hdf5 directory, or .csv files in csv directory. -Model inputs: -* matrix containing 130 feature vectors corresponding to frequency +Model inputs (x): +* A matrix containing 130 feature vectors corresponding to frequency, each 26 tokens long, corresponding to number of measurements. +* (Work in progress) 3x26 matrix containing backscatter brightness, normalized standard deviation and backscatter brightness. + +Encoder output (y): +* Two 1xN one-hot encoded classification vectors that predicts sample type and treatment applied. + +### Decoding + +Work in progress