Sign upLogin

tensorflow/models

View on GitHub
Star
official/utils/docs/build_tfm_api_docs.py

Summary

Maintainability
A
3 hrs
Test Coverage

Function hide_module_model_and_layer_methods has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

def hide_module_model_and_layer_methods():
  """Hide methods and properties defined in the base classes of Keras layers.

  We hide all methods and properties of the base classes, except:
  - `__init__` is always documented.
Severity: Minor
Found in official/utils/docs/build_tfm_api_docs.py - About 1 hr to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function gen_api_docs has 6 arguments (exceeds 4 allowed). Consider refactoring.
Open

def gen_api_docs(code_url_prefix, site_path, output_dir, project_short_name,
Severity: Minor
Found in official/utils/docs/build_tfm_api_docs.py - About 45 mins to fix

    Function make_factory_options_table has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

      def make_factory_options_table(self):
    lines = [
        '',
        'Allowed values for `exp_name`:',
        '',
    Severity: Minor
    Found in official/utils/docs/build_tfm_api_docs.py - About 35 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    There are no issues that match your filters.

    Category
    Status