Commit 133a6ac2 authored by Yuncong Yu's avatar Yuncong Yu
Browse files

Update README

parent b83cab40
...@@ -19,7 +19,8 @@ To run the application, make sure you've installed the following: ...@@ -19,7 +19,8 @@ To run the application, make sure you've installed the following:
2. Conda e.g. from https://docs.conda.io/projects/conda/en/latest/user-guide/install/linux.html 2. Conda e.g. from https://docs.conda.io/projects/conda/en/latest/user-guide/install/linux.html
3. Angular: https://angular.io/guide/setup-local 3. Angular: https://angular.io/guide/setup-local
4. Java: https://www.java.com/en/download/help/download_options.html 4. Java: https://www.java.com/en/download/help/download_options.html
5. (Only for Windows) `make` in git Bash: https://gist.github.com/evanwill/0207876c3243bbb6863e65ec5dc3f058 5. (Only for Windows) MSVC build tool: https://visualstudio.microsoft.com/
6. (Only for Windows) `make` in git Bash: https://gist.github.com/evanwill/0207876c3243bbb6863e65ec5dc3f058
### Step 1: Create an environment ### Step 1: Create an environment
All dependencies are listed in the *environment.yml* file. To create an environment, run the following command: All dependencies are listed in the *environment.yml* file. To create an environment, run the following command:
...@@ -31,8 +32,8 @@ This will create a conda environment named *pseudo*. Now activate the environmen ...@@ -31,8 +32,8 @@ This will create a conda environment named *pseudo*. Now activate the environmen
The LSH algorithm is maintained locally for now, so you'll have to create it manually. The file that you need to setup this package is The LSH algorithm is maintained locally for now, so you'll have to create it manually. The file that you need to setup this package is
located in the backend folder (this is more efficient when debugging, as for every change you have to rebuild the package). located in the backend folder (this is more efficient when debugging, as for every change you have to rebuild the package).
So the package can be created by running the following code: So the package can be created by running the following code:
`cd backend\libs` `cd backend/libs`
`python3 setup.py build_ext --inplace && python3 setup.py install` `python setup.py build_ext --inplace && python setup.py install`
`cd ..` `cd ..`
**NOTE 1**: So as a reminder, don't forget to run the 2nd line everytime you change something in the c++ code. **NOTE 1**: So as a reminder, don't forget to run the 2nd line everytime you change something in the c++ code.
...@@ -62,6 +63,22 @@ You may want to use [HDFView](https://www.hdfgroup.org/downloads/hdfview/) to ex ...@@ -62,6 +63,22 @@ You may want to use [HDFView](https://www.hdfgroup.org/downloads/hdfview/) to ex
use the python library [PyTables](https://www.pytables.org/usersguide/tutorials.html) or use the python library [PyTables](https://www.pytables.org/usersguide/tutorials.html) or
[h5py](https://docs.h5py.org/en/stable/index.html) to convert your data into HDF format. [h5py](https://docs.h5py.org/en/stable/index.html) to convert your data into HDF format.
### Tips and comments
This PSEUDo version is a prototype, which is prone to bugs and insufficient functions.
It is released for evaluation and knowledge exchange.
We are working on an upgraded version with augmented functionality and thorough tests.
However, the open-source issue is still under discussion.
You may find the following tips or comments useful:
- PSEUDo is designed mainly for high-dimensional time series. Its sublinear scalability refers to the asymptotic complexity with respect to the number of tracks;
- PSEUDo's active learning mainly works for high-dimensional time series. Because the mechanism works by attaching larger weights to important tracks. Though updating query with DBA works also in univariate case;
- The track weights and query will be updated in each feedback round, however, the hash functions are initialized rather than incrementally learnt;
- Only positive labels take effect and negative labels are ignored in this version;
- This version does not support variable query length. Namely, the patterns searched for in the time series should have similar length as the query;
- You may want to use the same query length because the preprocessed data and the estimated LSH parameters are cached. Especially the latter takes some time.
- The loaded tracks may not scale well vertically. Tuning the range slider rescales it properly.
# Documentation # Documentation
## Frontend Views ## Frontend Views
The UI is backed up by the Angular framework. The UI is backed up by the Angular framework.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment