Compare commits
No commits in common. "main" and "v0.1.0" have entirely different histories.
100
README.md
100
README.md
|
|
@ -1,6 +1,6 @@
|
|||
<h2 align="center">
|
||||
<br>
|
||||
<img src="https://riahub.ai/qoherent/ria-toolkit-oss/raw/branch/main/docs/images/ria_logo.svg" alt="RIA Toolkit OSS", width="400">
|
||||
<img src="./docs/images/ria_logo.svg" alt="RIA Toolkit OSS" style="width: 400px; height: auto;">
|
||||
</h2>
|
||||
|
||||
<h3 align="center">RIA Toolkit OSS, By <a href="https://qoherent.ai/">Qoherent</a></h3>
|
||||
|
|
@ -9,16 +9,20 @@
|
|||
|
||||
<p align="center">
|
||||
<!-- PyPI -->
|
||||
<a href="https://pypi.org/project/ria-toolkit-oss/">
|
||||
<a href="https://pypi.org/project/ria-toolkit-oss">
|
||||
<img src="https://img.shields.io/pypi/v/ria-toolkit-oss"/>
|
||||
</a>
|
||||
<!-- Conda-Forge -->
|
||||
<a href="https://anaconda.org/conda-forge/ria-toolkit-oss">
|
||||
<img src="https://img.shields.io/conda/vn/conda-forge/ria-toolkit-oss"/>
|
||||
</a>
|
||||
<!-- License -->
|
||||
<a href="https://www.gnu.org/licenses/agpl-3.0">
|
||||
<img src="https://img.shields.io/badge/License-AGPLv3-blue.svg" />
|
||||
</a>
|
||||
<!-- Docs -->
|
||||
<a href="https://ria-toolkit-oss.readthedocs.io/">
|
||||
<img src="https://img.shields.io/badge/docs-ria--toolkit--oss-blue"/>
|
||||
<a href="https://radiointelligence.io/">
|
||||
<img src="https://img.shields.io/badge/docs-ria--core-blue"/>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
|
|
@ -36,68 +40,36 @@ RIA Toolkit OSS is the open-source version of the RIA Toolkit, providing the fun
|
|||
|
||||
- (Coming soon) Basic model training and testing utilities.
|
||||
|
||||
## 💡 Want More RIA?
|
||||
## 🚀 Want More RIA?
|
||||
|
||||
- **[RIA Toolkit](https://qoherent.ai/riatoolkit/)**: The full, unthrottled set of tools for developing, testing, and deploying radio intelligence applications.
|
||||
- **[RIA Toolkit](https://riahub.ai/)**: The full, unthrottled set of tools for developing, testing, and deploying radio intelligence applications.
|
||||
|
||||
- **[RIA Hub](https://qoherent.ai/riahub/)**: Wield the RIA Toolkit, plus purpose-built automations, directly in your browser, without the need to write code or set up infrastructure. Additionally, unlock access to Qoherent's rich IP library as well as community projects.
|
||||
- **[RIA Hub](https://riahub.ai/)**: Wield the RIA Hub Toolkit plus purpose-built automations directly in your browser, without the need to write code or setup infrastructure. Additionally, unlock access to Qoherent's rich IP library as well as community projects.
|
||||
|
||||
- **[RIA RAN](https://qoherent.ai/intelligent-5g-ran/)**: Radio intelligence solutions engineered to seamlessly integrate with existing RAN environments, including ORAN-compliant networks.
|
||||
- **[RIA RAN](https://www.qoherent.ai/radiointelligenceapps-ran/)**: Radio intelligence solutions engineered to seamlessly integrate with existing RAN environments, including ORAN-compliant networks.
|
||||
|
||||
## 🚀 Getting started
|
||||
|
||||
RIA Hub Toolkit OSS can be installed either as a Conda package or as a standard Python package.
|
||||
The RIA Hub Toolkit OSS is available on [PyPI](https://pypi.org/project/ria/), [Conda Forge](https://anaconda.org/conda-forge/ria) and [RIA Hub](https://riahub.ai/qoherent/-/packages).
|
||||
|
||||
### Installation with Conda (recommended)
|
||||
- [ ] TODO: Update links once official listings are reserved
|
||||
|
||||
Conda package for RIA Toolkit OSS are available on RIA Hub: [RIA Hub Conda Package Registry: `ria-toolkit-oss`](https://riahub.ai/qoherent/-/packages/conda/ria-toolkit-oss).
|
||||
### Installation from Conda Forge (recommended)
|
||||
|
||||
RIA Toolkit OSS can be installed into any Conda environment. However, it is recommended to install within the base environment of [Radioconda](https://github.com/radioconda/radioconda-installer), which includes [GNU Radio](https://www.gnuradio.org/) and several pre-configured libraries for common SDR devices. Detailed instructions for installing and setting up Radioconda are available in the project README.
|
||||
While the RIA Toolkit OSS can be installed into any Conda environment, it is recommended to use RIA Toolkit OSS is within a [Radioconda](https://anaconda.org/ryanvolz/radioconda) environment, which provides pre-configured packages and libraries required for common SDR devices. Radioconda installation and setup instructions can be found in the project README: [`radioconda-installer`](https://github.com/radioconda/radioconda-installer).
|
||||
|
||||
Please follow the steps below to install RIA Toolkit OSS using Conda:
|
||||
|
||||
1. Before installing RIA Toolkit OSS into your Conda environment, update the Conda package manager:
|
||||
|
||||
```bash
|
||||
conda update --force conda
|
||||
```
|
||||
|
||||
This ensures that the Conda package manager is fully up-to-date, allowing new or updated packages to be installed into the base environment without conflicts.
|
||||
|
||||
2. Add RIA Hub to your Conda channel configuration:
|
||||
|
||||
```bash
|
||||
conda config --add channels https://riahub.ai/api/packages/qoherent/conda
|
||||
```
|
||||
|
||||
3. Activate your Conda environment and install RIA Toolkit OSS. For example, with Radioconda:
|
||||
Install RIA Toolkit OSS into the base environment:
|
||||
|
||||
```bash
|
||||
conda activate base
|
||||
conda install ria-toolkit-oss
|
||||
```
|
||||
|
||||
4. After installing RIA Toolkit OSS, verify that the installation was successful by running:
|
||||
(Coming soon) Install RIA Toolkit OSS from RIA Hub's Conda Package Registry.
|
||||
|
||||
```bash
|
||||
conda list
|
||||
```
|
||||
### Installation from PyPI / RIA Hub
|
||||
|
||||
If installation was successful, you should see a line item for `ria-toolkit-oss`:
|
||||
|
||||
```bash
|
||||
ria-toolkit-oss <version> <build> https://riahub.ai/api/packages/qoherent/conda
|
||||
```
|
||||
|
||||
### Installation with pip
|
||||
|
||||
RIA Toolkit OSS is available as a standard Python package on both RIA Hub and PyPI:
|
||||
- [RIA Hub PyPI Package Registry: `ria-toolkit-oss`](https://riahub.ai/qoherent/-/packages/pypi/ria-toolkit-oss)
|
||||
- [PyPI: `ria-toolkit-oss`](https://pypi.org/project/ria-toolkit-oss/)
|
||||
|
||||
These packages can be installed into a standard Python virtual environment using [pip](https://pip.pypa.io/en/stable/). For help getting started with Python virtual environments, please refer to the following tutorial: [Python Virtual Environments](https://www.w3schools.com/python/python_virtualenv.asp).
|
||||
|
||||
Please follow the steps below to install RIA Toolkit OSS using pip:
|
||||
You can also install RIA Toolkit OSS in a standard Python virtual environment using Pip. Addition information on Python virtual environments can be found here: [W3Schools: Python Virtual Environment](https://www.w3schools.com/python/python_virtualenv.asp).
|
||||
|
||||
1. Create and activate a Python virtual environment:
|
||||
|
||||
|
|
@ -116,53 +88,55 @@ Please follow the steps below to install RIA Toolkit OSS using pip:
|
|||
|
||||
</details>
|
||||
|
||||
2. Install RIA Toolkit OSS from PyPI with pip:
|
||||
2. Install RIA Toolkit OSS with Pip:
|
||||
|
||||
```bash
|
||||
pip install ria-toolkit-oss
|
||||
```
|
||||
|
||||
RIA Toolkit OSS can also be installed from RIA Hub. However, RIA Hub does not yet support a proxy or cache for public packages. We intend to add this missing functionality soon. In the meantime, please use the `--no-deps` option with pip to skip automatic dependency installation, and then manually install each dependency afterward.
|
||||
RIA Toolkit OSS can also be installed from the RIA Hub Python Index. However, because RIA Hub does not yet support a proxy or cache for public packages, you need to use the `--no-deps` option with pip to skip automatic dependency installation, and then manually install each dependency afterward.
|
||||
|
||||
```bash
|
||||
pip install --index-url https://riahub.ai/api/packages/qoherent/pypi/simple/ ria-toolkit-oss --no-deps
|
||||
```
|
||||
|
||||
### Installation from source
|
||||
|
||||
Finally, RIA Toolkit OSS can be installed directly from the source code. This approach is only recommended if you require an unpublished or development version of the project. Follow the steps below to install RIA Toolkit OSS from source:
|
||||
You can also install RIA Toolkit OSS directly from the source code:
|
||||
|
||||
1. Clone the repository. For example:
|
||||
|
||||
```bash
|
||||
git clone https://riahub.ai/qoherent/ria-toolkit-oss.git
|
||||
```
|
||||
|
||||
2. Navigate into the project directory:
|
||||
|
||||
```bash
|
||||
cd ria-toolkit-oss
|
||||
```
|
||||
|
||||
3. Install with pip:
|
||||
|
||||
3. Install the package:
|
||||
```bash
|
||||
pip install .
|
||||
```
|
||||
|
||||
### Basic usage
|
||||
|
||||
Once the project is installed, you can import modules, functions, and classes from the Toolkit for use in your Python code. For example, you can use the following import statement to access the `Recording` object:
|
||||
|
||||
Once the project is installed, you can import its modules, functions, and classes for use in your Python code. For example, you can use the following import statement to access the `Recording` object:
|
||||
```python
|
||||
from ria_toolkit_oss.datatypes import Recording
|
||||
```
|
||||
|
||||
Additional usage information is provided in the project documentation: [RIA Toolkit OSS Documentation](https://ria-toolkit-oss.readthedocs.io/).
|
||||
Additional usage information is provided in the project documentation.
|
||||
|
||||
- [ ] TODO: Link project documentation URL is finalized.
|
||||
|
||||
## 🐛 Issues
|
||||
|
||||
Kindly report any issues on RIA Hub: [RIA Toolkit OSS Issues Board](https://riahub.ai/qoherent/ria-toolkit-oss/issues).
|
||||
Kindly report any issues to the project issues board on RIA Hub: [RIA Toolkit OSS Issues Board](https://riahub.qoherent.internal:3000/qoherent/utils/issues).
|
||||
|
||||
## 🤝 Contribution
|
||||
|
||||
Contributions are always welcome! Whether it's an enhancement, bug fix, or new example, your input is valuable. If you'd like to contribute to the project, please reach out to the project maintainers.
|
||||
Contributions are always welcome! Whether it's an enhancement, bug fix, or new usage example, your input is valuable. If you'd like to contribute to the project, please reach out to the project maintainers.
|
||||
|
||||
If you have a larger project in mind, please [contact us](https://www.qoherent.ai/contact/) directly, we'd love to collaborate with you. 🚀
|
||||
|
||||
|
|
@ -195,7 +169,7 @@ To ensure a consistent development environment, this project uses [Poetry](https
|
|||
poetry install
|
||||
```
|
||||
|
||||
Running `install` when a `poetry.lock` file is present resolves and installs all dependencies listed in `pyproject.toml`, but Poetry uses the exact versions listed in `poetry.lock` to ensure that the package versions are consistent for everyone working on your project. Please note that the project itself will be installed in editable mode.
|
||||
Running `install` when a `poetry.lock` file is present resolves and installs all dependencies listed in `pyproject.toml`, but Poetry uses the exact versions listed in `poetry.lock` to ensure that the package versions are consistent for everyone working on your project. Please note that the project itself will be installed in editable mode when running `poetry install`.
|
||||
|
||||
Unit tests can be run with the following command:
|
||||
```bash
|
||||
|
|
@ -211,7 +185,7 @@ For more information on basic Poetry usage, start [here](https://python-poetry.o
|
|||
|
||||
### Sphinx
|
||||
|
||||
Project documentation is auto-generated from project docstrings using [Sphinx](https://www.sphinx-doc.org/en/master/). Therefore, all importable components require complete and comprehensive docstrings, complete with [doctest](https://docs.python.org/3/library/doctest.html) usage examples.
|
||||
Project documentation is auto-generated from project docstrings using [Sphinx](https://www.sphinx-doc.org/en/master/). Therefore, all importable components require comprehensive docstrings, complete with doctests demonstrating usage.
|
||||
|
||||
It's recommended to use `sphinx-autobuild`, which eliminates the need to manually rebuild the docs after making changes:
|
||||
```bash
|
||||
|
|
@ -235,7 +209,7 @@ For more information on basic Sphinx usage, start [here](https://sphinx-rtd-tuto
|
|||
This project uses [`tox`](https://tox.wiki/en/latest/index.html) to streamline testing and release. tox runs linting and formatting checks and tests
|
||||
the package across multiple version of Python.
|
||||
|
||||
Use the following command to run tests with tox:
|
||||
To run the tests, simply execute:
|
||||
```bash
|
||||
poetry run tox
|
||||
```
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))
|
|||
project = 'ria-toolkit-oss'
|
||||
copyright = '2025, Qoherent Inc'
|
||||
author = 'Qoherent Inc.'
|
||||
release = '0.1.2'
|
||||
release = '0.1.0'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ Contribution
|
|||
Contributions are always welcome! Whether it's an enhancement, bug fix, or new usage examples, your input is valuable.
|
||||
If you're interested in contributing to RIA Toolkit OSS, please don't hesitate to reach out to the project maintainers.
|
||||
|
||||
The project’s guidelines are outlined in its ``README.md`` file.
|
||||
The project guidelines are outlined in the project ``README.md`` file.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,4 @@
|
|||
Getting Started
|
||||
===============
|
||||
|
||||
.. todo::
|
||||
|
||||
Getting started instructions are coming soon! In the meantime, feel free
|
||||
to explore the project documentation, where many components include usage examples.
|
||||
RIA Toolkit OSS is a Python library.
|
||||
|
|
|
|||
|
|
@ -1,69 +1,30 @@
|
|||
Installation
|
||||
============
|
||||
|
||||
RIA Hub Toolkit OSS can be installed either as a Conda package or as a standard Python package.
|
||||
Installation from Conda Forge (recommended)
|
||||
-------------------------------------------
|
||||
|
||||
We want your experience with RIA Toolkit OSS to be as smooth and frictionless as possible. If you run into any
|
||||
issues during installation, please reach out to our support team: ``support@qoherent.ai``.
|
||||
It is recommended to use RIA Toolkit OSS is within a `Radioconda <https://anaconda.org/ryanvolz/radioconda>`_ environment,
|
||||
which provides pre-configured packages and libraries required for common SDR devices. Radioconda installation and setup instructions
|
||||
can be found in the project README: `radioconda-installer <https://github.com/radioconda/radioconda-installer>`_.
|
||||
|
||||
Installation with Conda (recommended)
|
||||
-------------------------------------
|
||||
|
||||
Conda packages for RIA Toolkit OSS are available on the RIA Hub
|
||||
`here <https://riahub.ai/qoherent/-/packages/conda/ria-toolkit-oss>`_.
|
||||
|
||||
RIA Toolkit OSS can be installed into any Conda environment. However, it is recommended to install within the base environment of
|
||||
`Radioconda <https://github.com/radioconda/radioconda-installer>`_, which includes `GNU Radio <https://www.gnuradio.org/>`_ and several pre-configured libraries for
|
||||
common SDR devices. Detailed instructions for installing and setting up Radioconda are available in the project README.
|
||||
|
||||
Please follow the steps below to install RIA Toolkit OSS using Conda:
|
||||
|
||||
1. Before installing RIA Toolkit OSS into your Conda environment, update the Conda package manager:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
conda update --force conda
|
||||
|
||||
This ensures that the Conda package manager is fully up-to-date, allowing new or updated packages to be installed into the base environment without conflicts.
|
||||
|
||||
2. Add RIA Hub to your Conda channel configuration:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
conda config --add channels https://riahub.ai/api/packages/qoherent/conda
|
||||
|
||||
3. Activate your Conda environment and install RIA Toolkit OSS. For example, with Radioconda:
|
||||
Install RIA Toolkit OSS into the base environment:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
conda activate base
|
||||
conda install ria-toolkit-oss
|
||||
|
||||
4. After installing RIA Toolkit OSS, verify that the installation was successful by running:
|
||||
.. note::
|
||||
|
||||
.. code-block:: bash
|
||||
**(Coming soon)** Install RIA Toolkit OSS from RIA Hub's Conda Package Registry.
|
||||
|
||||
conda list
|
||||
Installation from PyPI / RIA Hub
|
||||
--------------------------------
|
||||
|
||||
If installation was successful, you should see a line item for `ria-toolkit-oss`:
|
||||
You can also install RIA Toolkit OSS in a standard Python virtual environment using Pip.
|
||||
Addition information on Python virtual environments can be found here: `W3Schools: Python Virtual Environment <https://www.w3schools.com/python/python_virtualenv.asp>`_.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
ria-toolkit-oss <version> <build> https://riahub.ai/api/packages/qoherent/conda
|
||||
|
||||
Installation with pip
|
||||
---------------------
|
||||
|
||||
RIA Toolkit OSS is available as a standard Python package on both RIA Hub
|
||||
`here <https://riahub.ai/qoherent/-/packages/pypi/ria-toolkit-oss>`_ and PyPI
|
||||
`here <https://pypi.org/project/ria-toolkit-oss/>`_.
|
||||
|
||||
These packages can be installed into a standard Python virtual environment using
|
||||
`pip <https://pip.pypa.io/en/stable/>`_. For help getting started with Python virtual
|
||||
environments, please refer to the following tutorial:
|
||||
`Python Virtual Environments <https://www.w3schools.com/python/python_virtualenv.asp>`_.
|
||||
|
||||
Please follow the steps below to install RIA Toolkit OSS using pip:
|
||||
|
||||
1. Create and activate a Python virtual environment:
|
||||
|
||||
|
|
@ -81,23 +42,23 @@ Please follow the steps below to install RIA Toolkit OSS using pip:
|
|||
python -m venv venv
|
||||
venv\Scripts\activate
|
||||
|
||||
2. Install RIA Toolkit OSS from PyPI with pip:
|
||||
|
||||
2. Install RIA Toolkit OSS with Pip:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install ria-toolkit-oss
|
||||
|
||||
RIA Toolkit OSS can also be installed from RIA Hub. However, RIA Hub does not yet support a proxy or cache for public packages.
|
||||
We intend to add this missing functionality soon. In the meantime, please use the ``--no-deps`` option with pip to skip automatic
|
||||
dependency installation, and then manually install each dependency afterward.
|
||||
RIA Toolkit OSS can also be installed from the RIA Hub Python Index. However, because RIA Hub does not yet support a proxy or cache for public packages, you need to use the `--no-deps` option with pip to skip automatic dependency installation, and then manually install each dependency afterward.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install --index-url https://riahub.ai/api/packages/qoherent/pypi/simple/ ria-toolkit-oss --no-deps
|
||||
|
||||
Installation from source
|
||||
------------------------
|
||||
|
||||
Finally, RIA Toolkit OSS can be installed directly from the source code.
|
||||
This approach is only recommended if you require an unpublished or development version of the project.
|
||||
Follow the steps below to install RIA Toolkit OSS from source:
|
||||
You can also install RIA Toolkit OSS directly from the source code:
|
||||
|
||||
1. Clone the repository. For example:
|
||||
|
||||
|
|
@ -111,8 +72,16 @@ Follow the steps below to install RIA Toolkit OSS from source:
|
|||
|
||||
cd ria-toolkit-oss
|
||||
|
||||
3. Install with pip:
|
||||
3. Install the package:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install .
|
||||
|
||||
.. note::
|
||||
|
||||
If you plan to modify the project code and want changes to take effect immediately without reinstalling, you can install the project in editable mode:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install -e .
|
||||
|
|
|
|||
69
meta.yaml
Normal file
69
meta.yaml
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
# To release a new version of RIA Toolkit OSS on Conda-Forge, please update this
|
||||
# recipe by addressing the below comments. Please refrain from versioning
|
||||
# any updates to this file unless they are expected to persist across all
|
||||
# or many future releases. Please remember to remove all comments prior
|
||||
# to staging this recipe.
|
||||
{% set name = "ria-toolkit-oss" %}
|
||||
# Enter the version number below, and then remove this comment. Please
|
||||
# use the version identifier of the release you want to upload to Conda-Forge,
|
||||
# which is not necessarily the current version indicated in pyproject.toml.
|
||||
# E.g., {% set version = "0.1.2" %}
|
||||
{% set version = "..." %}
|
||||
|
||||
package:
|
||||
name: {{ name|lower }}
|
||||
version: {{ version }}
|
||||
|
||||
source:
|
||||
url: https://pypi.io/packages/source/{{ name[0] }}/{{ name }}/ria-toolkit-oss-{{ version }}.tar.gz
|
||||
# Copy the SHA256 **source** distribution hash from PyPI: https://pypi.org/project/ria-toolkit-oss/#files,
|
||||
# paste it below, and then remove this comment. Please use the hash corresponding the version
|
||||
# identifier entered above.
|
||||
# E.g., sha256: d32879a4e1b3e102fc5d65338f623764fbfb197570e536a5dfd57197aeec74c5
|
||||
sha256: ...
|
||||
|
||||
build:
|
||||
number: 0
|
||||
noarch: python
|
||||
script: {{ PYTHON }} -m pip install . --no-deps -vv
|
||||
|
||||
requirements:
|
||||
host:
|
||||
- python >=3.10
|
||||
- poetry
|
||||
- pip
|
||||
run:
|
||||
# Confirm that all the runtime dependencies are listed here, and then
|
||||
# remove this comment. Please include all dependencies within the
|
||||
# [dependencies] section in pyproject.toml.
|
||||
- python >=3.10
|
||||
- numpy ==1.26.4
|
||||
- scipy <1.16
|
||||
- sigmf >=1.2.10,<2.0.0
|
||||
- quantiphy >=2.20,<3.0
|
||||
- plotly >=6.3.0,<7.0.0
|
||||
- h5py >=3.14.0,<4.0.0
|
||||
- pandas >=2.3.2,<3.0.0
|
||||
|
||||
test:
|
||||
imports:
|
||||
- ria_toolkit_oss
|
||||
commands:
|
||||
- pip check
|
||||
requires:
|
||||
- pip
|
||||
|
||||
about:
|
||||
home: https://riahub.ai/qoherent/ria-toolkit-oss
|
||||
summary: Radio Intelligence Apps' open-source core, by Qoherent 📡🚀
|
||||
description: |
|
||||
An open-source version of the RIA Toolkit, including the fundamental tools to get started developing, testing, and deploying radio intelligence applications
|
||||
license: AGPL-3.0-only
|
||||
license_file: LICENSE
|
||||
|
||||
extra:
|
||||
recipe-maintainers:
|
||||
# Ensure there are at least 2 maintainers listed, notify all maintainers
|
||||
# of your intent to publish, and then remove this comment.
|
||||
- mrl280
|
||||
- benChinnery
|
||||
4
poetry.lock
generated
4
poetry.lock
generated
|
|
@ -764,8 +764,8 @@ files = [
|
|||
[package.dependencies]
|
||||
numpy = [
|
||||
{version = ">=1.22.4", markers = "python_version < \"3.11\""},
|
||||
{version = ">=1.26.0", markers = "python_version >= \"3.12\""},
|
||||
{version = ">=1.23.2", markers = "python_version == \"3.11\""},
|
||||
{version = ">=1.26.0", markers = "python_version >= \"3.12\""},
|
||||
]
|
||||
python-dateutil = ">=2.8.2"
|
||||
pytz = ">=2020.1"
|
||||
|
|
@ -921,8 +921,8 @@ astroid = ">=3.3.8,<=3.4.0.dev0"
|
|||
colorama = {version = ">=0.4.5", markers = "sys_platform == \"win32\""}
|
||||
dill = [
|
||||
{version = ">=0.2", markers = "python_version < \"3.11\""},
|
||||
{version = ">=0.3.6", markers = "python_version >= \"3.11\""},
|
||||
{version = ">=0.3.7", markers = "python_version >= \"3.12\""},
|
||||
{version = ">=0.3.6", markers = "python_version == \"3.11\""},
|
||||
]
|
||||
isort = ">=4.2.5,<5.13 || >5.13,<7"
|
||||
mccabe = ">=0.6,<0.8"
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[project]
|
||||
name = "ria-toolkit-oss"
|
||||
version = "0.1.2"
|
||||
version = "0.1.0"
|
||||
description = "An open-source version of the RIA Toolkit, including the fundamental tools to get started developing, testing, and deploying radio intelligence applications"
|
||||
license = { text = "AGPL-3.0-only" }
|
||||
readme = "README.md"
|
||||
|
|
|
|||
|
|
@ -145,85 +145,100 @@ class RadioDataset(ABC):
|
|||
classes_to_augment: Optional[str | list[str]] = None,
|
||||
inplace: Optional[bool] = False,
|
||||
) -> RadioDataset | None:
|
||||
"""
|
||||
Supplement the dataset with new examples by applying various transformations
|
||||
to the pre-existing examples in the dataset.
|
||||
"""Supplement the dataset with new examples by applying various transformations to the pre-existing examples
|
||||
in the dataset.
|
||||
|
||||
.. todo::
|
||||
|
||||
This method is currently under construction, and may produce unexpected results.
|
||||
|
||||
The process of supplementing a dataset to artificially increase the diversity
|
||||
of examples is called augmentation. Training on augmented data can enhance
|
||||
the generalization and robustness of deep machine learning models. For more
|
||||
information, see `A Complete Guide to Data Augmentation
|
||||
The process of supplementing a dataset to artificially increases the diversity of the examples is called
|
||||
augmentation. In many cases, training on augmented data can enhance the generalization and robustness of
|
||||
deep machine learning models. For more information on the benefits and limitations of data
|
||||
augmentation, please refer to this tutorial by Abid Ali Awan: `A Complete Guide to Data Augmentation
|
||||
<https://www.datacamp.com/tutorial/complete-guide-data-augmentation>`_.
|
||||
|
||||
Metadata for each new example will be identical to the metadata of the
|
||||
pre-existing example from which it was generated. The metadata will be
|
||||
extended to include an 'augmentation' column, populated with the string
|
||||
representation of the transform used.
|
||||
The metadata for each new example will be identical to the metadata of the pre-existing example from
|
||||
which it was generated. However, the metadata will be extended to include a 'augmentation' column, which will
|
||||
be populated for each new example with the string representation of the transform used to generate it, and left
|
||||
empty for all the pre-existing examples.
|
||||
|
||||
Augmented data should only be used for model training, not for testing or
|
||||
validation.
|
||||
Please note that augmented data should only be utilized for model training, not for testing or validation.
|
||||
|
||||
Unless specified, augmentations are applied equally across classes, maintaining
|
||||
the original class distribution.
|
||||
Unless specified, augmentations are applied equally across classes, maintaining the original class
|
||||
distribution.
|
||||
|
||||
If target_size does not match the sum of the original class sizes scaled by
|
||||
an integer multiple, the class distribution is slightly adjusted to satisfy
|
||||
target_size.
|
||||
In the case where target_size is not equal to the sum of the original class sizes scaled by an integer
|
||||
multiple, it is not possible to maintain the original class distribution, so the distribution gets slightly
|
||||
skewed to satisfy target_size. To do this, each class size gets divided by the total size and then
|
||||
multiplied by target_size, then these values all get rounded to the nearest integers. If the target_size is
|
||||
not equal to the sum of the rounded sizes, the sizes get sorted based on their decimal portions and then
|
||||
values are adjusted one by one until the target_size is reached.
|
||||
|
||||
:param class_key: Class name used to augment from and calculate class distribution.
|
||||
:param class_key: Class name that is used to augment from and calculate class distribution.
|
||||
:type class_key: str
|
||||
|
||||
:param augmentations: A function or list of functions that take an example
|
||||
and return a transformed version. Defaults to ``default_augmentations()``.
|
||||
:param augmentations: A function or a list of functions that take as input an example from the
|
||||
dataset and return a transformed version of that example. If no augmentations are specified, the default
|
||||
augmentations returned by the ``default_augmentations()`` method will be applied.
|
||||
:type augmentations: callable or list of callables, optional
|
||||
|
||||
:param level: The extent of augmentation from 0.0 (none) to 1.0 (full). If
|
||||
``classes_to_augment`` is specified, can be either:
|
||||
|
||||
* A single float: All classes augmented evenly to this level.
|
||||
* A list of floats: Each element corresponds to the augmentation level
|
||||
target for the corresponding class.
|
||||
|
||||
:param level: The level or extent of data augmentation to apply, ranging from 0.0 (no augmentation) to
|
||||
1.0 (full augmentation, where each augmentation is applied to each pre-existing example).
|
||||
|br| |br| If ``classes_to_augment`` is specified, this can be either:
|
||||
* A single float:
|
||||
All classes are augmented evenly to this level, maintaining the original class distribution.
|
||||
* A list of floats:
|
||||
Each element corresponds to the augmentation level target for the corresponding class.
|
||||
The default is 1.0.
|
||||
:type level: float or list of floats, optional
|
||||
|
||||
:param target_size: Target size of the augmented dataset. Overrides ``level``
|
||||
if specified. If ``classes_to_augment`` is specified, can be either:
|
||||
|
||||
* A single float: All classes are augmented proportional to their
|
||||
relative frequency until the dataset reaches target_size.
|
||||
* A list of floats: Each element corresponds to the target size for the
|
||||
corresponding class.
|
||||
|
||||
:param target_size: Target size of the augmented dataset. If specified, ``level`` is ignored, and augmentations
|
||||
are applied to expand the dataset to contain the specified number of examples.
|
||||
If ``classes_to_augment`` is specified, this can be either:
|
||||
* A single float:
|
||||
All classes are augmented proportional to their relative frequency until the dataset reaches the
|
||||
target size, maintaining the original class distribution.
|
||||
* A list of floats:
|
||||
Each element in the list corresponds to the target size for the corresponding class.
|
||||
Defaults to None.
|
||||
:type target_size: int or list of ints, optional
|
||||
|
||||
:param classes_to_augment: List of metadata keys of classes to augment.
|
||||
:param classes_to_augment: List of the metadata keys of the classes to augment. If specified, only these
|
||||
classes will be augmented. Defaults to None.
|
||||
:type classes_to_augment: string or list of strings, optional
|
||||
|
||||
:param inplace: If True, the augmentation is performed inplace and ``None`` is returned.
|
||||
:param inplace: If True, the augmentation is performed inplace and ``None`` is returned. Defaults to False.
|
||||
:type inplace: bool, optional
|
||||
|
||||
:raises ValueError: If level has any values not in the range (0,1].
|
||||
:raises ValueError: If level has any values that are not in the range (0,1].
|
||||
:raises ValueError: If target_size of dataset is already sufficed.
|
||||
:raises ValueError: If a class in classes_to_augment does not exist in class_key.
|
||||
:raises ValueError: If a class name in classes_to_augment does not exist in the specified class_key.
|
||||
|
||||
:return: The augmented dataset or None if ``inplace=True``.
|
||||
:rtype: RadioDataset or None
|
||||
|
||||
**Examples:**
|
||||
|
||||
>>> from ria.dataset_manager.builders import AWGN_Builder
|
||||
>>> from ria.dataset_manager.builders import AWGN_Builder()
|
||||
>>> builder = AWGN_Builder()
|
||||
>>> builder.download_and_prepare()
|
||||
>>> ds = builder.as_dataset()
|
||||
>>> ds.get_class_sizes(class_key='col')
|
||||
{'a': 100, 'b': 500, 'c': 300}
|
||||
{a:100, b:500, c:300}
|
||||
>>> new_ds = ds.augment(class_key='col', classes_to_augment=['a', 'b'], target_size=1200)
|
||||
>>> new_ds.get_class_sizes(class_key='col')
|
||||
{'a': 150, 'b': 750, 'c': 300}
|
||||
{a:150 b:750, c:300}
|
||||
|
||||
>>> from ria.dataset_manager.builders import AWGN_Builder()
|
||||
>>> builder = AWGN_Builder()
|
||||
>>> builder.download_and_prepare()
|
||||
>>> ds = builder.as_dataset()
|
||||
>>> ds.get_class_sizes(class_key='col')
|
||||
{a:50, b:20, c:130}
|
||||
>>> new_ds = ds.augment(class_key='col', level=0.5)
|
||||
>>> new_ds.get_class_sizes(class_key='col')
|
||||
{a:75 b:30, c:195}
|
||||
"""
|
||||
|
||||
if augmentations is None:
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ class Recording:
|
|||
Metadata is stored in a dictionary of key value pairs,
|
||||
to include information such as sample_rate and center_frequency.
|
||||
|
||||
Annotations are a list of :class:`~ria_toolkit_oss.datatypes.Annotation`,
|
||||
Annotations are a list of :ref:`Annotation <ria_toolkit_oss.datatypes.Annotation>`,
|
||||
defining bounding boxes in time and frequency with labels and metadata.
|
||||
|
||||
Here, signal data is represented as a NumPy array. This class is then extended in the RIA Backends to provide
|
||||
|
|
@ -48,7 +48,7 @@ class Recording:
|
|||
|
||||
:param metadata: Additional information associated with the recording.
|
||||
:type metadata: dict, optional
|
||||
:param annotations: A collection of :class:`~ria_toolkit_oss.datatypes.Annotation` objects defining bounding boxes.
|
||||
:param annotations: A collection of ``Annotation`` objects defining bounding boxes.
|
||||
:type annotations: list of Annotations, optional
|
||||
|
||||
:param dtype: Explicitly specify the data-type of the complex samples. Must be a complex NumPy type, such as
|
||||
|
|
@ -444,6 +444,34 @@ class Recording:
|
|||
else:
|
||||
raise ValueError(f"Key {key} is protected and cannot be modified or removed.")
|
||||
|
||||
def view(self, output_path: Optional[str] = "images/signal.png", **kwargs) -> None:
|
||||
"""Create a plot of various signal visualizations as a PNG image.
|
||||
|
||||
:param output_path: The output image path. Defaults to "images/signal.png".
|
||||
:type output_path: str, optional
|
||||
:param kwargs: Keyword arguments passed on to ria_toolkit_oss.view.view_sig.
|
||||
:type: dict of keyword arguments
|
||||
|
||||
**Examples:**
|
||||
|
||||
Create a recording and view it as a plot in a .png image:
|
||||
|
||||
>>> import numpy
|
||||
>>> from ria_toolkit_oss.datatypes import Recording
|
||||
|
||||
>>> samples = numpy.ones(10000, dtype=numpy.complex64)
|
||||
>>> metadata = {
|
||||
>>> "sample_rate": 1e6,
|
||||
>>> "center_frequency": 2.44e9,
|
||||
>>> }
|
||||
|
||||
>>> recording = Recording(data=samples, metadata=metadata)
|
||||
>>> recording.view()
|
||||
"""
|
||||
from ria_toolkit_oss.view import view_sig
|
||||
|
||||
view_sig(recording=self, output_path=output_path, **kwargs)
|
||||
|
||||
def to_sigmf(self, filename: Optional[str] = None, path: Optional[os.PathLike | str] = None) -> None:
|
||||
"""Write recording to a set of SigMF files.
|
||||
|
||||
|
|
@ -459,6 +487,22 @@ class Recording:
|
|||
:raises IOError: If there is an issue encountered during the file writing process.
|
||||
|
||||
:return: None
|
||||
|
||||
**Examples:**
|
||||
|
||||
Create a recording and view it as a plot in a `.png` image:
|
||||
|
||||
>>> import numpy
|
||||
>>> from ria_toolkit_oss.datatypes import Recording
|
||||
|
||||
>>> samples = numpy.ones(10000, dtype=numpy.complex64)
|
||||
>>> metadata = {
|
||||
... "sample_rate": 1e6,
|
||||
... "center_frequency": 2.44e9,
|
||||
... }
|
||||
|
||||
>>> recording = Recording(data=samples, metadata=metadata)
|
||||
>>> recording.view()
|
||||
"""
|
||||
from ria_toolkit_oss.io.recording import to_sigmf
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user