Only Modified Base.py #21
Conversation
autoprof/fit/base.py
Outdated
| """ Returns the value of lambda (regularization strength) at which minimum chi^2 loss was achieved. | ||
|
|
||
| Returns: | ||
| float: Value of lambda at which minimum chi^2 loss was achieved. |
There was a problem hiding this comment.
this is right except the return type is ndarray, not float
autoprof/fit/base.py
Outdated
| iteration (int): The current iteration number. | ||
| save_steps (Union[None, int]): The frequency at which to save intermediate results. | ||
| relative_tolerance (float): The relative tolerance for the optimization. | ||
| lambda_history (List[float]): A list of the optimization steps. |
There was a problem hiding this comment.
The type here is List[ndarray], not list[float]
There was a problem hiding this comment.
Okay I'll be resolving it right now
Thanks
So I have to do it for all codes in autoprof dir?
There was a problem hiding this comment.
for now you can just change float -> ndarray in the line above. Eventually it would be great to do docstrings for every function, but that can be done in a future PR.
|
Hi ranbir7, those updates to the docs look great! Thanks so much for helping out with the development, I really appreciate it! I have noted two points where there is a slight mistake in the data type indicated for the lambda_history variable. This is my first time running a PR from an external user, is it possible for you to make those minor changes? If so that would be great :) Then I'll approve the merge request and it will be part of the main branch! This is very exciting! |
|
yes I'll be resolving those changes |
|
I'll be doing for the rest .py files in the fit dir |
Please Tell me if this is the way I should use docstrings...