Migration Guide
This release of NeoRadium introduces a significant reorganization of classes and functions to make the API simpler and more consistent to use. All example notebooks in Playground have been updated to reflect the new API. The documentation has also been revised to clearly mark deprecated classes and functions and to point to their recommended replacements. In addition, the documentation for the new APIs includes examples that show how to update existing code.
Most deprecated functionality remains available for now to ease the transition. However, NeoRadium may emit warning messages to remind users to migrate to the new API.
The only deprecated classes are LdpcBase, LdpcEncoder, and LdpcDecoder. These classes have been replaced by LdpcCodec, whose documentation includes a dedicated section on migrating existing code.
The table below lists deprecated functions and their recommended replacements.
Deprecated |
Use instead |
|---|---|