Skip to content

Commit ccfc4a3

Browse files
modifying the MFPT documentation and notebook
1 parent d052c29 commit ccfc4a3

2 files changed

Lines changed: 36 additions & 14 deletions

File tree

docs/datasets.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,17 @@ kaist.mine(mining_params)
236236

237237
##### Instantiation: ```MFPT(base_directory, folders)```
238238
- ```base_directory``` is the home directory of the extracted file.
239-
- ```folders``` is the list of folders to include; valid elements are *1 - Three Baseline Conditions*, *2 - Three Outer Race Fault Conditions*, *3 - Seven More Outer Race Fault Conditions* and *4 - Seven Inner Race Fault Conditions*.
239+
- ```files``` is the list of files to include; valid elements are:
240+
- *baseline_1.mat*
241+
- *InnerRaceFault_vload_1.mat*
242+
- *InnerRaceFault_vload_2.mat*
243+
- *InnerRaceFault_vload_4.mat*
244+
- *InnerRaceFault_vload_7.mat*
245+
- *OuterRaceFault_1.mat*
246+
- *OuterRaceFault_vload_1.mat*
247+
- *OuterRaceFault_vload_2.mat*
248+
- *OuterRaceFault_vload_4.mat*
249+
- *OuterRaceFault_vload_7.mat*
240250

241251
##### Mining: ```MFPT.mine(mining_params)```
242252
- ```mining_params``` is a nested python dictonary whose keys are 97656 and 48828 (sampling frequencies the dataset is collected by) and the corresponding values are objects of python dictonary. Secondary dictonaries each have two keys: ```win_len``` and ```hop_len``` with correponding values.
@@ -257,15 +267,21 @@ downloader = ZipDatasetDownloader(addresses['MFPT'])
257267
downloader.download_extract('MFPT.zip', 'MFPT/')
258268

259269
# Mining the dataset
260-
mfpt = MFPT('MFPT/MFPT Fault Data Sets/', [
261-
    '1 - Three Baseline Conditions',
262-
    '2 - Three Outer Race Fault Conditions',
263-
    '3 - Seven More Outer Race Fault Conditions',
264-
    '4 - Seven Inner Race Fault Conditions',
270+
mfpt = MFPT('MFPT/', [
271+
'baseline_1.mat',
272+
'InnerRaceFault_vload_1.mat',
273+
'InnerRaceFault_vload_2.mat',
274+
'InnerRaceFault_vload_4.mat',
275+
'InnerRaceFault_vload_7.mat',
276+
'OuterRaceFault_1.mat',
277+
'OuterRaceFault_vload_1.mat',
278+
'OuterRaceFault_vload_2.mat',
279+
'OuterRaceFault_vload_4.mat',
280+
'OuterRaceFault_vload_7.mat',
265281
])
266282
mining_params = {
267-
    97656: {'win_len': 16671, 'hop_len': 2000},
268-
    48828: {'win_len': 8337, 'hop_len': 1000},
283+
97656: {'win_len': 16671, 'hop_len': 2000},
284+
48828: {'win_len': 8337, 'hop_len': 1000},
269285
}
270286
mfpt.mine(mining_params)
271287
```

docs/notebooks/dataset_demos/MFPT_demo.ipynb

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -253,17 +253,23 @@
253253
},
254254
{
255255
"cell_type": "code",
256-
"execution_count": 3,
256+
"execution_count": null,
257257
"metadata": {
258258
"id": "mRa9eF-0PIEh"
259259
},
260260
"outputs": [],
261261
"source": [
262-
"mfpt = MFPT('MFPT/MFPT Fault Data Sets/', [\n",
263-
" '1 - Three Baseline Conditions',\n",
264-
" '2 - Three Outer Race Fault Conditions',\n",
265-
" '3 - Seven More Outer Race Fault Conditions',\n",
266-
" '4 - Seven Inner Race Fault Conditions',\n",
262+
"mfpt = MFPT('MFPT/', [\n",
263+
" 'baseline_1.mat',\n",
264+
"\t'InnerRaceFault_vload_1.mat',\n",
265+
"\t'InnerRaceFault_vload_2.mat',\n",
266+
"\t'InnerRaceFault_vload_4.mat',\n",
267+
"\t'InnerRaceFault_vload_7.mat',\n",
268+
"\t'OuterRaceFault_1.mat',\n",
269+
"\t'OuterRaceFault_vload_1.mat',\n",
270+
"\t'OuterRaceFault_vload_2.mat',\n",
271+
"\t'OuterRaceFault_vload_4.mat',\n",
272+
"\t'OuterRaceFault_vload_7.mat',\n",
267273
"])\n",
268274
"mining_params = {\n",
269275
" 97656: {'win_len': 16671, 'hop_len': 2000},\n",

0 commit comments

Comments
 (0)