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

More documentation for --tedpca #547

Closed
benoitberanger opened this issue Mar 6, 2020 · 5 comments · Fixed by #551 or #613
Closed

More documentation for --tedpca #547

benoitberanger opened this issue Mar 6, 2020 · 5 comments · Fixed by #551 or #613
Assignees
Labels
documentation issues related to improving documentation for the project

Comments

@benoitberanger
Copy link
Contributor

Summary

Between version 0.0.7 and 0.0.8, the --tedpca parameter changed.
Is it planned to enhance the documentation explaining which tedpca does what ?

Additional Detail

The "decision tree" part in the code is proably the most difficult part

Help in 0.0.7 :

Possible choices: mle, kundu, kundu-stabilize
Method with which to select components in TEDPCA
Default: “mle”

Help in 0.0.8 :

Possible choices: kundu, kundu-stabilize, mdl, aic, kic
Method with which to select components in TEDPCA. PCA decomposition with the mdl, kic and aic options is based on a Moving Average (stationary Gaussian) process and are ordered from most to least aggresive. Default=’mdl’.
Default: “mdl”

Next Steps

Explain a bit more what does each decision tree ?
In particular, why "mdl" is choose to be the default one ?

@tsalo tsalo added the documentation issues related to improving documentation for the project label Mar 8, 2020
@tsalo
Copy link
Member

tsalo commented Mar 21, 2020

@eurunuela You know the PCA methods best at this point. Would you be willing to take this on?

@eurunuela
Copy link
Collaborator

Sure, I can tackle this!

@eurunuela
Copy link
Collaborator

#551 should take care of this.

@benoitberanger
Copy link
Contributor Author

Thanks you @eurunuela and @tsalo !

@eurunuela
Copy link
Collaborator

I'm going to reopen this as some people still feel like this section of the docs is not very clear.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to improving documentation for the project
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants