[Feature] Timing Fed Components

[sun1lach]

Core timeout functionality is in place.
To apply timeouts to any function/method in openfl codebase, import and decorate the function with @fedtiming.

from openfl.utilities.fed_timer import fedtiming

@fedtiming(timeout=10)    #10 seconds
def some_function(*args, **kwargs):
    pass

Update: 20th Oct

The @fedtiming can now be decorated on normal python functions or async co-routine likewise. Usage remains the same.

[igor-davidyuk]

Consider using functool.wraps to keep function method names for logging and debugging.
https://stackoverflow.com/questions/308999/what-does-functools-wraps-do

[sun1lach]

@igor-davidyuk
@psfoley

Extended the capability of the @fedtiming decorator to support asynchronous co-routine methods as well.
Tested with below async methods in director.py

• start_experiment_execution_loop
• wait_experiment

Usage remains the same. Decorate the async methods with
@fedtiming(timeout=<seconds>)

[igor-davidyuk]

1. Please scan this module with flake8, it will highlight a lot of issues.
2. Please add unit tests covering different use cases.

[sun1lach]

@igor-davidyuk @psfoley

• Refactored from decorator function to decorator class.
• Removed redundant and repetitive code.
• sync and async decorator factory for better managing decorator state.
• Implemented contextmanager to better handle repetitive/redundant code across async and sync wrappers.
• flake8 compliant.

[igor-davidyuk]

• flake8 compliant.

Looks like our flake8 config is broken. There is no way flake8 would pass with no comment lines

[sun1lach]

• flake8 compliant.

Looks like our flake8 config is broken. There is no way flake8 would pass with no comment lines

I see!
I tested the module with the by default/standard flake8 config in my local.
Do let me know if there is any custom flake8 config used in the OpenFL CI to make it compliant, I can validate the same in my local.

Also yes, will add comments and docstrings :)

[sun1lach]

Looks like by default flake doesn't capture naming_conventions and docstrings etc according to pycodestyle.
https://stackoverflow.com/questions/60403545/flake8-not-giving-errors-warnings-on-missing-docstring-or-code-not-following-pep

[sun1lach]

This change can be merged independently.

Static timeout values defined in the director_config.yml would require code change in yml parse logic and in any one of the interactive example.

[psfoley]

@acharyasunil the changes look good on my end. Could you also add documentation for how someone would apply this feature to debug infrastructure / performance issues?

[psfoley]

1. Please scan this module with flake8, it will highlight a lot of issues.
2. Please add unit tests covering different use cases.

From @igor-davidyuk's comment, @acharyasunil It looks like all that is missing at this point are unit tests. After that, this is ready to merge.