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

The doc of the BasisFactory class has no example. #1218

Open
mbaudin47 opened this issue Sep 12, 2019 · 4 comments
Open

The doc of the BasisFactory class has no example. #1218

mbaudin47 opened this issue Sep 12, 2019 · 4 comments

Comments

@mbaudin47
Copy link
Collaborator

mbaudin47 commented Sep 12, 2019

In the doc of the BasisFactory class:

http://openturns.github.io/openturns/master/user_manual/response_surface/_generated/openturns.BasisFactory.html

there is no example.

@mbaudin47
Copy link
Collaborator Author

The context of this bug is the will to create a kriging algorithm with an arbitrary trend. It is easy to create a kriging with a constant, linear or quadratic basis, but, there is no example of how to create a kriging algorithm with a customized trend.

@jschueller jschueller added the doc label Sep 12, 2019
@josephmure
Copy link
Collaborator

I think python/doc/examples/meta_modeling/kriging_metamodel/plot_kriging_beam_arbitrary_trend.py a.k.a. "Configuring an arbitrary trend in Kriging" shows what you want. What do you think @mbaudin47 ?

@mbaudin47
Copy link
Collaborator Author

Not in my sense. My message highlights the fact that the API help page has no example.

There are at least two different places for examples, each with a specific content.

  • In my dreams, any API page has a minimal example showing the minimum number of lines of codes (the minimal working example) which creates the object and use its main methods. It focuses on the software and presents the input and output arguments of the class and its methods.
  • On the other hand, examples in the "Examples" section shows how to combine several classes in order to create something meaningful in practice. This is a synthesis exercise. Such a page has interesting examples, which are relevant to the UQ methodology.

@mbaudin47
Copy link
Collaborator Author

mbaudin47 commented Sep 15, 2022

A related class is Basis, which does provide not enough examples:

https://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Basis.html

Two examples may be created :

  • create a basis with several functions, based on Symbolic or Python functions,
  • create a basis from the several outputs of a multivariate function.

Another example of a custom basis is provided at FunctionalChaosAlgorithm with your own orthonormal basis construction

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

No branches or pull requests

3 participants