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

Add demo notebook and per-primitive documentation #48

Merged
merged 7 commits into from
Dec 11, 2023
Merged

Conversation

andyx13
Copy link
Collaborator

@andyx13 andyx13 commented Dec 8, 2023

Added demo notebook and per-primitive documentation

@andyx13 andyx13 requested a review from sarahmish December 8, 2023 23:11
@andyx13 andyx13 marked this pull request as draft December 8, 2023 23:12
@@ -0,0 +1,485 @@
{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the demo notebook should be separated from the package. I suggest creating a folder under root tutorials and move the notebook there.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it - notebook has been moved to the tutorials folder.

Comment on lines 293 to 305
" turbine_id signal_id xvalues \\\n",
"0 T001 Sensor1_signal1 2020-01-01 00:00:00 \n",
"1 T001 Sensor1_signal1 2020-01-01 01:00:00 \n",
"2 T001 Sensor1_signal1 2020-01-01 02:00:00 \n",
"3 T001 Sensor1_signal1 2020-01-01 03:00:00 \n",
"4 T001 Sensor1_signal1 2020-01-01 04:00:00 \n",
"\n",
" yvalues sampling_frequency \n",
"0 [0.43616983763682876, -0.17662312586241055, 0.... 1000 \n",
"1 [0.8023828754411122, -0.14122063493312714, -0.... 1000 \n",
"2 [-1.3143142430046044, -1.1055740033788437, -0.... 1000 \n",
"3 [-0.45981995520032104, -0.3255426061995603, -0... 1000 \n",
"4 [-0.6380405111460377, -0.11924167777027689, 0.... 1000 "
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

based on our previous discussions, is this the new supported format where we have xvalues as a column of type list (like yvalues)? Or is it the original format?

  1. If it is the former, I would make xvalues a list just like yvalues.
  2. If it is the latter, I would change the column name to timestamp to follow the dummy data https://raw.githubusercontent.com/sintel-dev/SigPro/master/sigpro/data/demo_timeseries.csv

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The xvalues column has been revised to be a list, just like yvalues -- should be correct now.

@andyx13 andyx13 linked an issue Dec 9, 2023 that may be closed by this pull request
@andyx13 andyx13 marked this pull request as ready for review December 11, 2023 07:03
@sarahmish sarahmish self-requested a review December 11, 2023 18:00
Copy link
Contributor

@sarahmish sarahmish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@andyx13 andyx13 requested a review from sarahmish December 11, 2023 18:01
@andyx13 andyx13 merged commit 8c58996 into master Dec 11, 2023
55 checks passed
@andyx13 andyx13 deleted the nov_release_small branch December 11, 2023 18:02
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 this pull request may close these issues.

Two-Column Data Format
2 participants