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

API documentation #57

Open
jonas-eschle opened this issue May 15, 2020 · 0 comments
Open

API documentation #57

jonas-eschle opened this issue May 15, 2020 · 0 comments
Assignees

Comments

@jonas-eschle
Copy link
Contributor

jonas-eschle commented May 15, 2020

Collection of what to document and the strategy:

What:
Data

  • constructors from_{root, numpy, pandas}
  • weights
  • n_obs

Space

  • rect_limits
  • rect_area
  • inside
  • filter
  • with_obs

params:

  • set_values
  • ConstantParameter
  • ComplexParameter
  • ComposedParameter

With the following methods important: lower, upper, floating, value, step_size

loss:

  • UnbinnedNLL, methods: value, get_params

minimize:

  • Minuit, methods: minimize

FitResult:

  • valid
  • errors
  • hesse
  • params
  • fmin
  • converged

pdf:

  • BasePDF, methods: pdf, _pdf, ext_pdf, _unnormalized_pdf, integrate, register_analytic_integral, _integrate, ext_integrate, sample, _sample, normalization, _normalization
  • Gauss, Exponential, CrystalBall, Uniform
@SebastianJL SebastianJL self-assigned this Jun 25, 2020
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

No branches or pull requests

2 participants