4.8 KiB
name, about, title, labels, assignees
name | about | title | labels | assignees | ||
---|---|---|---|---|---|---|
Feature Request | Suggest an idea for this project | [FEATURE] |
|
🚀 Feature Description
A clear and concise description of the feature you'd like to see implemented.
💡 Motivation
Is your feature request related to a problem? Please describe. A clear description of what the problem is. Ex. I'm always frustrated when [...]
Why would this feature be valuable?
- Improves performance for [specific use case]
- Adds functionality that is missing for [specific scenario]
- Makes the API more consistent with [reference implementation]
- Enables new applications in [domain/field]
🎯 Proposed Solution
Describe the solution you'd like A clear and concise description of what you want to happen.
API Design (if applicable)
// Example of how you envision the API would look
class SVMClassifier {
public:
// Proposed new method
NewFeatureResult new_feature_method(const torch::Tensor& input,
const FeatureParameters& params);
// Or modifications to existing methods
TrainingMetrics fit(const torch::Tensor& X,
const torch::Tensor& y,
const NewOptions& options = {});
};
🔄 Alternatives Considered
Describe alternatives you've considered
- Alternative implementation approaches
- Workarounds you've tried
- Other libraries that provide similar functionality
- Why those alternatives are not sufficient
📚 Examples and Use Cases
Provide concrete examples of how this feature would be used:
Example 1: [Use Case Name]
// Example code showing how the feature would be used
SVMClassifier svm;
auto result = svm.new_feature_method(data, params);
// Expected behavior and benefits
Example 2: [Another Use Case]
// Another example showing different usage
🔧 Implementation Considerations
Technical details (if you have insights):
- This would require changes to the core API
- This would add new dependencies
- This would affect performance
- This would require additional testing
- This would need documentation updates
Potential challenges:
- Dependencies on external libraries
- Compatibility with existing API
- Performance implications
- Memory usage considerations
- Cross-platform support
Rough implementation approach:
- Brief description of how this could be implemented
- Which components would need to be modified
- Any external dependencies required
📊 Expected Impact
Performance:
- Expected performance improvements/implications
- Memory usage changes
- Training/prediction time impact
Compatibility:
- This is a breaking change
- This is backward compatible
- This affects the public API
- This only affects internal implementation
Users:
- Who would benefit from this feature?
- How common is this use case?
- What's the expected adoption rate?
🌍 Related Work
References to similar functionality:
- Links to papers, documentation, or implementations
- How other libraries handle this feature
- Standards or best practices that should be followed
Prior art:
- scikit-learn: [link to relevant functionality]
- Other C++ ML libraries: [examples]
- Research papers: [citations]
⏰ Priority and Timeline
Priority level:
- High - Critical functionality that's blocking important use cases
- Medium - Useful feature that would improve the library
- Low - Nice-to-have enhancement
Timeline expectations:
- When would you ideally like to see this implemented?
- Are there any deadlines or external factors driving this request?
🤝 Contribution
Are you willing to contribute to implementing this feature?
- Yes, I can implement this feature
- Yes, I can help with testing and review
- Yes, I can help with documentation
- I can provide guidance but cannot implement
- I cannot contribute but would like to see this implemented
Your experience level:
- Expert in C++ and machine learning
- Experienced with C++ or machine learning
- Intermediate programmer
- Beginner but eager to learn
📋 Additional Context
Add any other context, screenshots, diagrams, or examples about the feature request here.
Related issues:
- Links to related issues or discussions
- Dependencies on other features
Documentation:
- What documentation would need to be updated?
- What examples should be added?
✅ Checklist
- I have searched for existing feature requests that might be similar
- I have provided clear motivation for why this feature is needed
- I have considered the implementation complexity and compatibility
- I have provided concrete examples of how this would be used
- I have indicated my willingness to contribute to the implementation