_add_newdocs.py 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. from numpy.lib 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,
  5. ifixx=None, ifixb=None, job=0, iprint=0, errfile=None, rptfile=None, ndigit=0,
  6. taufac=0.0, sstol=-1.0, partol=-1.0, maxit=-1, stpb=None, stpd=None, sclb=None,
  7. scld=None, work=None, iwork=None, full_output=0)
  8. Low-level function for ODR.
  9. .. deprecated:: 1.17.0
  10. `scipy.odr` is deprecated and will be removed in SciPy 1.19.0. Please use
  11. `pypi.org/project/odrpack/ <https://pypi.org/project/odrpack/>`_
  12. instead.
  13. See Also
  14. --------
  15. ODR : The ODR class gathers all information and coordinates the running of the
  16. main fitting routine.
  17. Model : The Model class stores information about the function you wish to fit.
  18. Data : The data to fit.
  19. RealData : Data with weights as actual std. dev.s and/or covariances.
  20. Notes
  21. -----
  22. This is a function performing the same operation as the `ODR`,
  23. `Model`, and `Data` classes together. The parameters of this
  24. function are explained in the class documentation.
  25. """)
  26. add_newdoc('scipy.odr.__odrpack', '_set_exceptions',
  27. """
  28. _set_exceptions(odr_error, odr_stop)
  29. Internal function: set exception classes.
  30. """)