Add SKILL.md for AI agents#147
Conversation
- Add comprehensive SKILL.md file for AI agents using sigmf-python - Include core operations, advanced features, and common workflows - Provide examples for reading RF signals, format conversion, and analysis - Include error handling and best practices - Meets requirements: <500 lines, <5000 tokens Resolves sigmf#139
Teque5
left a comment
Teque5
left a comment
There was a problem hiding this comment.
I believe the lesson of this paper is that any SKILL file should focus on simplicity and normal use cases.
In my recent PR I updated the README to cover a basic read/write implementation. If we do add a SKILL.md then I think it should start with something like that and then go into typical use cases. This PR has some good ideas but isn't there yet.
| ```python | ||
| # Basic signal properties | ||
| sample_rate = meta.sample_rate | ||
| center_freq = meta.core:frequency |
There was a problem hiding this comment.
Everything in here needs to be tested. This is invalid python syntax.
If a file had a center frequency for a capture, you would access it with meta.get_capture_info(0).get(sigmf.SigMFFile.FREQUENCY_KEY) or maybe there is a simpler way. Capture frequency isn't a required key.
| annotation = meta.annotations[0] if meta.annotations else None | ||
|
|
||
| # Process signal data | ||
| samples = meta.read_samples(start_index=0, count=1024) |
There was a problem hiding this comment.
I think slicing the signal is simpler. Like meta[0:1024] in this case.
|
|
||
| # Get basic properties | ||
| sample_rate = meta.sample_rate | ||
| center_freq = meta.core.get('frequency', 0) |
|
Take a look at #139. I posted something closer to what I was thinking for a SKILL file. Perhaps it's too many tokens though. |
2 participants
Add comprehensive SKILL.md file for AI agents using sigmf-python
Summary
This PR adds a SKILL.md file to help AI agents work with the sigmf-python library for processing RF time series data.
What's included
Requirements met
Testing
The SKILL.md file includes practical examples that can be directly used by AI agents for:
Resolves #139