v0.6.1 release (#267)

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,43 @@
+name: Bug Report
+description: File a bug report.
+title: "[Bug] "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: checkboxes
+    id: check-exist
+    attributes:
+      label: Is there an existing bug report already?
+      description: Please search to see if this bug has already been reported.
+      options:
+      - label: Yes, I have checked the exisitng bug reports.
+        required: true
+  - type: dropdown
+    id: version
+    attributes:
+      label: Version
+      description: What version of TorchSig? Note that any bugs before 0.5.1 are not prioritized.
+      options:
+        - 0.6.1 (Default)
+        - 0.6.0
+        - 0.5.3
+        - 0.5.1
+        - Other
+      default: 0
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Describe concisely what you expected to happen, what happened, and anything else.
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: How to Reproduce the Bug
+      description: Describe how to reproduce this bug.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,24 @@
+name: Feature Request
+description: Suggest an idea for this project.
+title: "[Feature] "
+labels: ["feature"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to request this new feature!
+  - type: checkboxes
+    id: check-exist
+    attributes:
+      label: Is there an existing feature already?
+      description: Please search to see if this feature has already been requested.
+      options:
+      - label: Yes, I have checked the existing features.
+        required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and consise description of the problem and how this new feature is the solution.
+    validations:
+      required: true

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -8,10 +8,11 @@ Describe how you tested and verified your changes here (changes captured in exis
 
 ## Before Submitting
 - [ ] Check for bugs/errors
-- [ ] Run example notebooks
-    - `examples/`
-    - Ensure all notebooks run successfully.
-- [ ] Run formatter if needed
-    - `pip3 install git+https://github.com/GooeeIOT/pyfmt.git`
-    - `pyfmt torchsig`
-
+    - [ ] Write or update unit tests in `tests/`
+    - [ ] Run example notebooks
+        - `examples/`
+        - Ensure all notebooks run successfully.
+- [ ] Code conforms with [PEP 8 Python Style Guide](https://peps.python.org/pep-0008/)
+- [ ] [Google-style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) used to document code
+    - This ensures our documentation stays up to date
+- [ ] Added contributers to PR

README.md

@@ -16,8 +16,9 @@
 - Hard drive storage with:
   - ≥ 500 GB for Narrowband
   - ≥ 10 TB for Wideband
+- ≥ 32 GB RAM
 - CPU with ≥ 4 cores
-- GPU with ≥ 16 GB storage (reccomended)
+- GPU with ≥ 16 GB storage (recommended)
 - Python ≥ 3.9
 
 We highly reccomend Ubuntu or using a Docker container.
@@ -30,6 +31,11 @@ cd torchsig
 pip install .
 ```
 
+# Examples and Tutorials
+
+TorchSig has a series of Jupyter notebooks in the `examples/` directory. View the README inside `examples/` to learn more.
+
+
 # Usage
 
 ## Generating the Datasets with Command Line

docs/_autosummary/torchsig.datasets.rst

@@ -32,6 +32,7 @@ torchsig.datasets
    modulations
    radioml
    sig53
+   sigmf_datasets
    signal_classes
    synthetic
    torchsig_narrowband

docs/_autosummary/torchsig.datasets.sigmf_datasets.SigMFDataset.rst

@@ -0,0 +1,24 @@
+torchsig.datasets.sigmf\_datasets.SigMFDataset
+==============================================
+
+.. currentmodule:: torchsig.datasets.sigmf_datasets
+
+.. autoclass:: SigMFDataset
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :special-members: __call__, __add__, __mul__
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :nosignatures:
+
+
+
+
+
+
+

docs/_autosummary/torchsig.datasets.sigmf_datasets.rst

@@ -0,0 +1,40 @@
+torchsig.datasets.sigmf\_datasets
+=================================
+
+.. automodule:: torchsig.datasets.sigmf_datasets
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+      sigmf_reader
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+      :template: custom_class_template.rst
+      :nosignatures:
+
+      SigMFDataset
+
+
+
+
+
+
+
+
+

docs/_autosummary/torchsig.datasets.sigmf_datasets.sigmf_reader.rst

@@ -0,0 +1,6 @@
+torchsig.datasets.sigmf\_datasets.sigmf\_reader
+===============================================
+
+.. currentmodule:: torchsig.datasets.sigmf_datasets
+
+.. autofunction:: sigmf_reader

docs/_autosummary/torchsig.datasets.signal_classes.torchsig_signals.rst

@@ -30,6 +30,7 @@ torchsig.datasets.signal\_classes.torchsig\_signals
       ~torchsig_signals.class_list
       ~torchsig_signals.constellation_signals
       ~torchsig_signals.family_dict
+      ~torchsig_signals.family_list
       ~torchsig_signals.fm_signals
       ~torchsig_signals.fsk_signals
       ~torchsig_signals.lfm_signals

docs/_autosummary/torchsig.image_datasets.datasets.dataset_generation.batched_write_yolo_synthetic_dataset.rst

@@ -0,0 +1,6 @@
+torchsig.image\_datasets.datasets.dataset\_generation.batched\_write\_yolo\_synthetic\_dataset
+==============================================================================================
+
+.. currentmodule:: torchsig.image_datasets.datasets.dataset_generation
+
+.. autofunction:: batched_write_yolo_synthetic_dataset

docs/_autosummary/torchsig.image_datasets.datasets.dataset_generation.rst

@@ -0,0 +1,32 @@
+torchsig.image\_datasets.datasets.dataset\_generation
+=====================================================
+
+.. automodule:: torchsig.image_datasets.datasets.dataset_generation
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+      batched_write_yolo_synthetic_dataset
+      save_yolo_data
+
+
+
+
+
+
+
+
+
+
+
+
+

docs/_autosummary/torchsig.image_datasets.datasets.dataset_generation.save_yolo_data.rst

@@ -0,0 +1,6 @@
+torchsig.image\_datasets.datasets.dataset\_generation.save\_yolo\_data
+======================================================================
+
+.. currentmodule:: torchsig.image_datasets.datasets.dataset_generation
+
+.. autofunction:: save_yolo_data