Skip to content

Commit

Permalink
Add description to docstring actors
Browse files Browse the repository at this point in the history
  • Loading branch information
lnauta committed Sep 4, 2024
1 parent 610f99d commit 9237687
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions picas/actors.py
Original file line number Diff line number Diff line change
Expand Up @@ -174,9 +174,10 @@ def run(self, max_time=None, avg_time_factor=0.0, max_tasks=0, stop_function=Non
logic is also extended into the EndlessViewIterator to break it when
the condition is met, otherwise it never stops.
@param max_time:
@param avg_time_factor:
@param max_tasks:
@param max_time: maximum time to run picas before stopping
@param avg_time_factor: used for estimating when to stop with `max_time`,
value is average time per token to run
@param max_tasks: number of tasks that are performed before stopping
@param stop_function: custom function to stop the execution, mustt return bool
@param stop_function_args: kwargs to supply to stop_function
"""
Expand Down

0 comments on commit 9237687

Please sign in to comment.