apache/mxnet

1 other commands the scanner could not classify

Commands from CI steps and task runners that look like checks but match no known tool. Some are checks, some are not.

• cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DUSE_ONEDNN=OFF -DUSE_CUDA=OFF -G Ninja ..

full scan as JSON

• Eliminate redundant constructsRemove unnecessary coding patterns that add complexity without providing value. Focus on clarity and simplicity by: 1. Not using enumerat...

  apache/mxnet Code Style Python ml-systems 2021-09-17

  copy raw open
• Technical precision mattersWhen documenting AI models, frameworks, and optimization techniques, precision in language is as important as precision in your algorithm...

  apache/mxnet AI Markdown ml-systems 2022-08-25

  copy raw open
• Simplify for readabilityComplex expressions, especially nested ternary operations, reduce code readability and maintainability. Prefer simpler alternatives: 1. B...

  apache/mxnet Code Style Other ml-systems 2022-08-25

  copy raw open
• Consistent naming patternsMaintain consistent naming conventions throughout the codebase to enhance readability and reduce confusion. This applies to: 1. **Import ...

  apache/mxnet Naming Conventions Python ml-systems 2022-02-02

  copy raw open
• Optimize iteration patternsWhen iterating through collections, choose the most efficient iteration pattern based on what information you actually need. If you only ...

  apache/mxnet Algorithms Python ml-systems 2021-08-25

  copy raw open
• Explain optimization mechanismsWhen implementing or documenting performance optimizations, clearly explain the mechanism and expected performance benefit. For memory-bo...

  apache/mxnet Performance Optimization Markdown ml-systems 2022-08-25

  copy raw open
• Use intent-revealing namesChoose names that clearly reveal the purpose, behavior, or type of the code elements they represent. A good name should answer "what" rat...

  apache/mxnet Naming Conventions Other ml-systems 2022-07-15

  copy raw open
• Document all parametersAlways provide complete and accurate documentation for all function parameters, especially when adding new ones. Each parameter should ha...

  apache/mxnet Documentation Other ml-systems 2022-04-08

  copy raw open
• Hybridization compatible operationsWhen implementing neural network models that will be hybridized for performance optimization, use operations that are compatible with sym...

  apache/mxnet AI Python ml-systems 2021-09-03

  copy raw open
• Explicit null checksAlways use explicit null checks (`value is None` or `value is not None`) rather than implicit truthiness evaluations when testing for nul...

  apache/mxnet Null Handling Python ml-systems 2022-04-19

  copy raw open
• Graph traversal optimizationWhen working with graph structures, avoid performing redundant depth-first search (DFS) traversals as each traversal incurs an O(V+E) com...

  apache/mxnet Algorithms Other ml-systems 2022-03-07

  copy raw open
• Avoid redundant calculationsEliminate redundant calculations by identifying and caching frequently used values to improve performance. Consider these optimization pa...

  apache/mxnet Performance Optimization Other ml-systems 2021-12-07

  copy raw open
• Comprehensive API documentationEnsure all API elements are thoroughly documented following a consistent format. This includes: 1. **All function parameters** must have ...

  apache/mxnet Documentation Python ml-systems 2021-10-03

  copy raw open
• Consistent logging formatUse consistent string formatting in logging statements throughout the codebase. Prefer `%` style placeholders over f-strings or `.format(...

  apache/mxnet Logging Python ml-systems 2022-09-12

  copy raw open
• Documentation clarity and formattingWhen writing documentation (README files, tutorials, API docs), ensure clarity and proper formatting: 1. **Define technical terms and con...

  apache/mxnet Documentation Markdown ml-systems 2022-07-08

  copy raw open
• Use explicit optional typesWhen dealing with values that may be absent or null, always use explicit optional type wrappers instead of implicit null checks or nullab...

  apache/mxnet Null Handling Other ml-systems 2022-01-28

  copy raw open
• Document environment variablesAll environment variables must be documented in the central env_var.md file with clear descriptions of their purpose, acceptable values, ...

  apache/mxnet Configurations Other ml-systems 2021-11-09

  copy raw open
• Centralize configuration parametersAvoid hardcoded paths and duplicated configuration values throughout the code. Instead: 1. Use dedicated configuration files for settings...

  apache/mxnet Configurations Shell ml-systems 2021-10-10

  copy raw open
• Document API completelyAlways provide comprehensive API documentation that clearly specifies: 1. **Parameter types** - Document all acceptable parameter types, ...

  apache/mxnet API Python ml-systems 2021-10-03

  copy raw open
• Centralize synchronization logicWhen implementing concurrent operations, especially in heterogeneous computing environments (CPU/GPU), centralize synchronization managem...

  apache/mxnet Concurrency Other ml-systems 2021-09-02

  copy raw open
• Pre-compute reused dataWhen data will be accessed multiple times during processing, avoid redundant calculations by pre-computing values upfront rather than usi...

  apache/mxnet Performance Optimization Python ml-systems 2022-08-25

  copy raw open
• Use named constantsIn AI model implementations, avoid using magic numbers directly in code as they reduce readability and make maintenance difficult. Always...

  apache/mxnet AI Other ml-systems 2022-03-10

  copy raw open
• Use pytest parameterizationStructure unit tests using pytest's parameterize decorator instead of manual loops or wrapper functions. This approach improves test read...

  apache/mxnet Testing Python ml-systems 2021-10-29

  copy raw open
• Consistent API documentationMaintain high-quality, consistent documentation as a critical component of API design. Documentation should feature: 1. Correct grammar a...

  apache/mxnet API Markdown ml-systems 2021-08-23

  copy raw open
• Avoid eval functionNever use the `eval()` function in Python code as it creates serious security vulnerabilities by executing arbitrary code at runtime. Thi...

  apache/mxnet Security Python ml-systems 2019-01-30

  copy raw open