Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Syntax for pipeline creation #41

Closed
andyx13 opened this issue Oct 12, 2023 · 0 comments · Fixed by #54
Closed

Syntax for pipeline creation #41

andyx13 opened this issue Oct 12, 2023 · 0 comments · Fixed by #54
Milestone

Comments

@andyx13
Copy link
Collaborator

andyx13 commented Oct 12, 2023

  • SigPro version: 0.1.2
  • Python version: 3.8
  • Operating System:

Description

As it stands, it is not clear what a sigpro.SigPro object actually is from the name alone. Currently, the approach to constructing and running a pipeline is to instantiate a sigpro.SigPro object:

mypipeline = sigpro.SigPro(transformations, aggregations, keep_columns = True)

Following this, we can run the pipeline on sample data using the process_signal instance method, which under the hood calls the _apply_pipeline method:

processed_data, feature_columns = pipeline.process_signal(dataframe, '1h', time_index = 'timestamp')

However, the sigpro.SigPro constructor itself calls the _build_pipeline method to actually build the pipeline. A more intuitive interface would look like:

mypipeline = sigpro.create_pipeline(transformations, aggregations, keep_columns = True)

This new create_pipeline method should still return a SigPro pipeline (potentially not a sigpro.SigPro object), and should preserve the process_signal interface.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant