Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FreeDV 2_0_0_ RADE Doc #762

Open
6 of 7 tasks
drowe67 opened this issue Oct 23, 2024 · 6 comments
Open
6 of 7 tasks

FreeDV 2_0_0_ RADE Doc #762

drowe67 opened this issue Oct 23, 2024 · 6 comments
Labels
before release Must be fixed before next public release

Comments

@drowe67
Copy link
Owner

drowe67 commented Oct 23, 2024

Collect, draft, review and publish documentation on RADE. Like the software, this should not be ad-hoc, but carefully thought out and reviewed, a team effort.

  • Collect info from disparate sources, such as (a) FreeDV 2.0.0-20241018 release email (b) RADE primer (c) any new instructions/notes that have been generated since 2.0.0-20241018
  • Add content on our roadmap. We need to avoid making any promises on feature enhancements the PLT has not committed to.
  • Document PLT policy re Windows/Linux/OSX distributions. For example "currently only Windows packaging is being maintained by FreeDV team - Linux users are welcome to compile from source, but must perform their own support".
  • Decide where to publish, It would be good to make this a single location, e.g. README.md or freedv.org web page.
  • Draft
  • Review
  • Publish
@drowe67 drowe67 added the before release Must be fixed before next public release label Oct 23, 2024
@drowe67 drowe67 changed the title FreeDV 0_0_ RADE Doc FreeDV 2_0_0_ RADE Doc Oct 25, 2024
@drowe67
Copy link
Owner Author

drowe67 commented Nov 13, 2024

https://freedv.org/radio-autoencoder/ has taken care of most of this.

Looks like all we have left on this one is the (RADE?) Roadmap. We need to be careful about making any big promises or timelines on public mailing lists - the initial RADE demo release is already massive delta. Much of the work from here on in will be "under the hood" (e.g. C port, bug fixes, minor features).

@Tyrbiter
Copy link

Looking at where we are now, I think we have to make it clear that whatever is released as RADEV1 with EOO text is going to be it until the C port is essentially done and all the ctests show it is working correctly.

Once people can see who they are receiving in good signal conditions then we can point to this as progress for everyday users.

The roadmap should avoid being definitive until the features under development can be shown to work as intended. And perhaps those feature improvements should be kept a bit quiet until it's clear that they do work in the real world with real channel impairments.

@tmiw
Copy link
Collaborator

tmiw commented Dec 29, 2024

Looking at where we are now, I think we have to make it clear that whatever is released as RADEV1 with EOO text is going to be it until the C port is essentially done and all the ctests show it is working correctly.

IIRC the C port is effectively done. The only part that hasn't been ported yet is the DSP stuff, and I don't know if that's going to happen before V2.

@Tyrbiter
Copy link

Looking at where we are now, I think we have to make it clear that whatever is released as RADEV1 with EOO text is going to be it until the C port is essentially done and all the ctests show it is working correctly.

IIRC the C port is effectively done. The only part that hasn't been ported yet is the DSP stuff, and I don't know if that's going to happen before V2.

I'm clearly not fully up to speed with what porting is needed. But when I refer to RADEV2 I mean a version with some of the improvements discussed with @drowe67 recently which is a step on from EOO text and RADEV1.

If I'm missing the details then I ought to know where to look to grasp the details.

@drowe67
Copy link
Owner Author

drowe67 commented Jan 1, 2025

Take a look at "C Port of Core ML" in my Nov progress report

@Tyrbiter
Copy link

Tyrbiter commented Jan 5, 2025

Oh yes, I had read it before but after reading it again I finally realised what it meant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
before release Must be fixed before next public release
Projects
None yet
Development

No branches or pull requests

3 participants