Skip to main content

Sequence Regression Functions

Project description

Logo

This package is for aiding in developing and running sequence regression models. The main use case is for boiling heat flux prediction via hydrophone, AE sensor, and optical image data. However, it is presented in a such a way where it can utilized for general sequence regression models if the data is prepared in the proper format. This package uses tensorflow and sklearn.

Installation:

This package requires the installation of tensorflow, scikit-learn, numpy, and pandas. After ensuring those are installed then install the package via pip:

pip install seqreg

Use:

Saving Data Format

Logo

SeqReg can be used for regression from 1D, 2D, or 3D (wip) inputs. It is designed to work with multiple sets of experimental data. Each experimental dataset must be saved in a csv. One column show contain time (or index) one should contain the output labels (in this case heat flux) corresponding to each input at the specified time. The other column should contain the model inputs. This could be just a single value, a path relative to the csv to an array saved in a txt file, or a path to an image.

Using SeqReg

Logo

To use SeqReg there are four main functions that must be used:

  • Load Data: This function will load in the data from the folders given they follow the format described. The user will input the location of the data and type. This function can be used for loading both training and testing data depending on the overall end goal.
  • Prepare Data: This function is used to convert the long sequences from each dataset into shorter sequences and the outputs. It also includes the option for converting each sequence into the frequency domain.
  • Model: This function provides a few options for defining the model:
    • Load Pre-Trained Model: For loading pretrained models, first the correct architecture must be defined. Additionally the corresponding weights must be downloaded and the path should be included in the function. There are currently 2 pretrained models provided from past work.

      Model Name Weights Location Description Parameters
      HydReg Link Predicts heat flux from hydrophone sound data recorded in pool boiling experiments [1] FFT=True, SeqLen=4000
      Hit2Flux Link Predicts heat flux from ae sensor hit data recored in pool boiling experiments [2] FFT=True, SeqLen=25, seqout=True
    • Train on Your Own Data: If you want to use a predefined model achitecture with your own data just set train to true, pass in training data, and define the weights location as where you want the weights/model to be saved. Set the model name to one of the already defined models.

    • Train Your Own Data on Custom Model: pending

  • Analysis: This function allows for performance visualization and returns a dictionary of performance metrics.

References

[1] C. Dunlap, H. Pandey, E. Weems, and H. Hu, “Nonintrusive Heat Flux Quantification Using Acoustic Emissions During Pool Boiling,” Appl Therm Eng, p. 120558, Apr. 2023, doi: 10.1016/j.applthermaleng.2023.120558.

[2]

[3] C. Dunlap, C. Li, H. Pandey, Y. Sun, and H. Hu, “A Temporal-Spatial Framework for Efficient Heat Flux Monitoring of Transient Boiling,” IEEE Trans Instrum Meas, 2024, doi: 10.1109/TIM.2024.3460944.

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

seqreg-0.0.0.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

seqreg-0.0.0-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file seqreg-0.0.0.tar.gz.

File metadata

  • Download URL: seqreg-0.0.0.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.16

File hashes

Hashes for seqreg-0.0.0.tar.gz
Algorithm Hash digest
SHA256 eddda98df06da2e31e5eb7232ab305fed3d1d555e8266ade384da10853383112
MD5 c65d2014ee5a97b940734b65f2bd34d6
BLAKE2b-256 d615341c96a52c9579cb7353684cb600fdee6c7b2a7a020f3fea97ebaf87f677

See more details on using hashes here.

File details

Details for the file seqreg-0.0.0-py3-none-any.whl.

File metadata

  • Download URL: seqreg-0.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.16

File hashes

Hashes for seqreg-0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 444e10be125543cec448d01ad2cee8316b547f7195090072be2e1f3c17f1bb3b
MD5 bea5de0d32c5604591ad4cabd9e74901
BLAKE2b-256 e8ecd59ee965a452b440ba09420e4a66425c66e480b0810852a68e4adbd62cc9

See more details on using hashes here.

Supported by

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