_add_newdocs.py 1.1 KB

123456789101112131415161718192021222324252627282930
  1. from numpy import add_newdoc
  2. add_newdoc('scipy.odr', 'odr',
  3. """
  4. odr(fcn, beta0, y, x, we=None, wd=None, fjacb=None, fjacd=None, extra_args=None, ifixx=None, ifixb=None, job=0, iprint=0, errfile=None, rptfile=None, ndigit=0, taufac=0.0, sstol=-1.0, partol=-1.0, maxit=-1, stpb=None, stpd=None, sclb=None, scld=None, work=None, iwork=None, full_output=0)
  5. Low-level function for ODR.
  6. See Also
  7. --------
  8. ODR : The ODR class gathers all information and coordinates the running of the main fitting routine.
  9. Model : The Model class stores information about the function you wish to fit.
  10. Data : The data to fit.
  11. RealData : Data with weights as actual std. dev.s and/or covariances.
  12. Notes
  13. -----
  14. This is a function performing the same operation as the `ODR`,
  15. `Model`, and `Data` classes together. The parameters of this
  16. function are explained in the class documentation.
  17. """)
  18. add_newdoc('scipy.odr.__odrpack', '_set_exceptions',
  19. """
  20. _set_exceptions(odr_error, odr_stop)
  21. Internal function: set exception classes.
  22. """)