Comprehensive coding guidelines for AI and financial computing projects with focus on machine learning models, financial calculations, and data handling best practices.
Comprehensive coding guidelines for AI and financial computing projects, emphasizing code quality, model validation, and financial compliance.
1. **Code Quality Standards**
- Prioritize code readability and maintainability
- Adhere to PEP 8 for Python or relevant style guides for other languages
- Use meaningful variable and function names that reflect their purpose
1. **Model Implementation**
- Use TensorFlow or PyTorch for deep learning models
- Implement traditional ML algorithms with Scikit-learn
- Properly validate all models using cross-validation techniques
- Document model performance metrics clearly (accuracy, precision, recall, F1-score)
2. **Model Development Best Practices**
- Split data into training, validation, and test sets
- Implement proper feature engineering pipelines
- Use appropriate evaluation metrics for your specific problem type
- Monitor for overfitting and underfitting
1. **Financial Data Handling**
- Use `Decimal` data type for currency calculations to avoid floating-point precision issues
- Implement proper risk management frameworks in trading algorithms
- Ensure compliance with financial regulations (GDPR, MiFID II, SOX)
- Handle time series data with appropriate indexing and resampling
2. **Required Libraries**
- **Pandas**: Data manipulation and analysis
- **NumPy**: Numerical computations
- **Plotly**: Interactive financial visualizations
- Consider QuantLib for advanced financial calculations
3. **Trading Algorithm Requirements**
- Implement position sizing and risk controls
- Include stop-loss and take-profit mechanisms
- Log all trading decisions with timestamps
- Backtest strategies on historical data before live deployment
1. **Data Validation and Security**
- Validate and sanitize all data sources before processing
- Handle missing data with appropriate imputation techniques
- Store sensitive financial data securely with proper encryption
- Implement data lineage tracking for audit purposes
2. **Data Processing Pipeline**
- Create reproducible data preprocessing steps
- Version control datasets and model artifacts
- Implement data quality checks and monitoring
- Use consistent data formats across the pipeline
1. **Testing Requirements**
- Write unit tests for all functions, especially financial calculations
- Apply test-driven development (TDD) principles
- Validate models against out-of-sample data
- Test edge cases and boundary conditions
2. **Financial Calculation Testing**
- Test calculations with known expected results
- Verify compliance with financial formulas and standards
- Test for numerical stability and precision
- Validate against third-party financial libraries when possible
1. **High-Performance Computing**
- Optimize code for high-frequency trading scenarios
- Profile code to identify and eliminate bottlenecks
- Use parallel processing and vectorization where applicable
- Consider GPU acceleration for computationally intensive tasks
2. **Memory and Resource Management**
- Implement efficient data structures for large datasets
- Use memory mapping for very large files
- Monitor memory usage and implement garbage collection strategies
- Cache frequently accessed computations
1. **Code Documentation**
- Write comprehensive docstrings for all functions
- Include parameter types, return values, and usage examples
- Document assumptions and limitations clearly
- Maintain API documentation for external interfaces
2. **Project Documentation**
- Maintain detailed README with setup instructions
- Document project goals and business requirements
- Provide usage examples and tutorials
- Include model performance benchmarks and validation results
1. **Regulatory Compliance**
- Implement audit trails for all financial transactions
- Ensure data retention policies meet regulatory requirements
- Document risk management procedures
- Regular compliance reviews and updates
2. **Error Handling and Monitoring**
- Implement comprehensive logging and monitoring
- Set up alerts for system failures and anomalies
- Create fallback procedures for critical systems
- Regular system health checks and performance monitoring
Leave a review
No reviews yet. Be the first to review this skill!
# Download SKILL.md from killerskills.ai/api/skills/ai-and-financial-computing-development-rules/raw