apunkt/GPy
1
0
Fork 0
mirror of https://github.com/SheffieldML/GPy.git synced 2026-05-21 14:05:14 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fixed docstring warnings - could still be mistakes

Browse source
This commit is contained in:
James McMurray 2013-09-20 13:38:20 +01:00
parent c36a6b341c
commit be3880c0bd
20 changed files with 261 additions and 144 deletions
Download patch file Download diff file Expand all files Collapse all files

19
GPy/inference/conjugate_gradient_descent.py
View file

@ -233,7 +233,7 @@ class CGD(Async_Optimize):
"""
opt_async(self, f, df, x0, callback, update_rule=FletcherReeves,
messages=0, maxiter=5e3, max_f_eval=15e3, gtol=1e-6,
report_every=10, *args, **kwargs)
report_every=10, \*args, \*\*kwargs)
callback gets called every `report_every` iterations
@ -244,16 +244,14 @@ class CGD(Async_Optimize):
f, and df will be called with
f(xi, *args, **kwargs)
df(xi, *args, **kwargs)
f(xi, \*args, \*\*kwargs)
df(xi, \*args, \*\*kwargs)
**returns**
-----------
**Returns:**
Started `Process` object, optimizing asynchronously
**calls**
---------
**Calls:**
callback(x_opt, f_opt, g_opt, iteration, function_calls, gradient_calls, status_message)
@ -265,7 +263,7 @@ class CGD(Async_Optimize):
"""
opt(self, f, df, x0, callback=None, update_rule=FletcherReeves,
messages=0, maxiter=5e3, max_f_eval=15e3, gtol=1e-6,
report_every=10, *args, **kwargs)
report_every=10, \*args, \*\*kwargs)
Minimize f, calling callback every `report_every` iterations with following syntax:
@ -276,11 +274,10 @@ class CGD(Async_Optimize):
f, and df will be called with
f(xi, *args, **kwargs)
df(xi, *args, **kwargs)
f(xi, \*args, \*\*kwargs)
df(xi, \*args, \*\*kwargs)
**returns**
---------
x_opt, f_opt, g_opt, iteration, function_calls, gradient_calls, status_message