diff --git a/.riahub/workflows/workflow.yaml b/.riahub/workflows/workflow.yaml index d422ada..012ad1e 100644 --- a/.riahub/workflows/workflow.yaml +++ b/.riahub/workflows/workflow.yaml @@ -1,4 +1,4 @@ -name: RIA Hub Workflow Demo +name: Modulation Recognition Demo on: push: @@ -11,9 +11,6 @@ on: jobs: ria-demo: runs-on: ubuntu-latest-2080 - env: - RIAGIT_USERNAME: ${{ secrets.USERNAME }} - RIAGIT_TOKEN: ${{ secrets.TOKEN }} steps: - name: Print GPU information run: | @@ -24,7 +21,7 @@ jobs: echo "⚠️ No NVIDIA GPU found" fi - - name: Checkout code + - name: Checkout project code uses: actions/checkout@v4 with: lfs: true @@ -36,19 +33,24 @@ jobs: - name: Install dependencies (incl. RIA Hub utils) run: | - python -m pip install --upgrade pip - pip install \ - --index-url "https://${{ secrets.RIAHUB_USER }}:${{ secrets.RIAHUB_TOKEN }}@git.riahub.ai/api/packages/qoherent/pypi/simple/" \ - utils \ - -r requirements.txt + set -e + + python -m pip install --upgrade pip + + echo "Trying to install utils from RIA Hub..." + if ! pip install \ + --index-url "https://${{ secrets.RIAHUB_USER }}:${{ secrets.RIAHUB_TOKEN }}@git.riahub.ai/api/packages/qoherent/pypi/simple/" \ + utils; then + echo "RIA Hub install failed, falling back to local wheel..." + pip install ./wheels/utils-*.whl + fi + pip install -r requirements.txt - - name: 1. Generate Recordings run: | mkdir -p data/recordings - PYTHONPATH=. python scripts/dataset_building/data_gen.py --output-dir data/recordings - echo "recordings produced successfully" + PYTHONPATH=. python scripts/dataset_manager/data_gen.py --output-dir data/recordings - name: ⬆️ Upload recordings uses: actions/upload-artifact@v3 @@ -59,11 +61,10 @@ jobs: - name: 2. Build HDF5 Dataset run: | mkdir -p data/dataset - PYTHONPATH=. python scripts/dataset_building/produce_dataset.py - echo "datasets produced successfully" + PYTHONPATH=. python scripts/dataset_manager/produce_dataset.py shell: bash - - name: 📤 Upload Dataset + - name: ⬆️ Upload Dataset uses: actions/upload-artifact@v3 with: name: dataset @@ -75,34 +76,30 @@ jobs: PYTORCH_NO_NNPACK: 1 run: | mkdir -p checkpoint_files - PYTHONPATH=. python scripts/training/train.py 2>/dev/null - echo "training model" + PYTHONPATH=. python scripts/model_builder/train.py 2>/dev/null - name: 4. Plot Model env: NO_NNPACK: 1 PYTORCH_NO_NNPACK: 1 run: | - PYTHONPATH=. python scripts/training/plot_data.py 2>/dev/null - + PYTHONPATH=. python scripts/model_builder/plot_data.py 2>/dev/null - - name: Upload Checkpoints + - name: ⬆️ Upload Checkpoints uses: actions/upload-artifact@v3 with: name: checkpoints path: checkpoint_files/* - - - name: 5. Convert to ONNX file + - name: 5. Export model to ONNX graph env: NO_NNPACK: 1 PYTORCH_NO_NNPACK: 1 run: | mkdir -p onnx_files - MKL_DISABLE_FAST_MM=1 PYTHONPATH=. python scripts/onnx/convert_to_onnx.py 2>/dev/null - echo "building inference app" + MKL_DISABLE_FAST_MM=1 PYTHONPATH=. python scripts/application_packager/convert_to_onnx.py 2>/dev/null - - name: Upload ONNX file + - name: ⬆️ Upload ONNX file uses: actions/upload-artifact@v3 with: name: onnx-file @@ -110,21 +107,20 @@ jobs: - name: 6. Profile ONNX model run: | - PYTHONPATH=. python scripts/onnx/profile_onnx.py + PYTHONPATH=. python scripts/application_packager/profile_onnx.py - - name: Upload JSON profiling data + - name: ⬆️ Upload JSON trace uses: actions/upload-artifact@v3 with: name: profile-data path: '**/onnxruntime_profile_*.json' - - name: 7. Convert to ORT file + - name: 7. Convert ONNX graph to an ORT file run: | - PYTHONPATH=. python scripts/ort/convert_to_ort.py + PYTHONPATH=. python scripts/application_packager/convert_to_ort.py - - name: Upload ORT file + - name: ⬆️ Upload ORT file uses: actions/upload-artifact@v3 with: name: ort-file path: ort_files/inference_recognition_model.ort - diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md index cd64ae1..a4bac4f 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,201 @@ -# ModrecWorkflow Demo -This project automates the process of generating data, training, and deploying the modulation recognition model for radio singal classification. The workflow is intended to support experimentation, reproducibility, and deployment of machine learning models for wireless signal modulation classification, such as QPSK, 16-QAM, BPSK, +# Modulation Recognition Demo -## Getting Started +RIA Hub Workflows is an automation platform integrated into RIA Hub. This project provides an example machine learning +workflow for signal modulation classification, offering a practical introduction to RIA Hub Workflows -1. Clone the Repository +## 📡 The machine learning development workflow + +The development of intelligent radio solutions involves multiple steps: + +1. First, we need to prepare a machine learning-ready dataset. This involves signal synthesis or capture, followed by +dataset curation to extract and qualify examples. Finally, we need to perform any required data preprocessing—such as +augmentation—and split the dataset into training and test sets. + + +2. Secondly, we need to design and train a model. This is typically an iterative process, often accelerated using +techniques such as Neural Architecture Search (NAS) and hyperparameter optimization (HPO), which help automate the +discovery of an effective model structure and optimal hyperparameter settings. + + +3. Once a machine learning model has been trained and validated, the next step is to build an inference application. +This step transforms the model from a research artifact into a practical tool capable of making predictions in +real-world conditions. Building an inference application typically involves several steps including model +optimization, packaging and integration, and monitoring and logging. + +This is a lot of work, and much of it involves tedious software development and repetitive tasks, like setting up and +configuring infrastructure. What's more? There is a shortage of domain expertize in ML and MLOps for radio. That's +where we come in. RIA Hub offers a no-code and low-code solution for automating the end-to-end development of +intelligent radio systems. + + +## ▶️ RIA Hub Workflows + +One of the core principles of RIA Hub is Workflows, which allow users to run jobs in isolated Docker containers. + +You can create workflows in one of two ways: +- Writing YAML and placing it in the special `.riahub/workflows/` directory in your repository. + + +- Using RIA Hub's built-in tools for Dataset Management, Model Building, and Application Development, which will +automatically generate the YAML workflow file(s) for you. + +Workflows can be configured to run automatically on push and pull request events. You can monitor and manage running +workflows in the 'Workflows' tab in your repository. + +Workflows require a _runner_, which retrieves job definitions from RIA Hub, executes them in isolated containers, and +reports the results back to RIA Hub. The next section outlines the convenience and advantage of using Qoherent-hosted +runners. The workflow configuration defines the specifications and settings of the available job containers. + +The best part? RIA Hub Workflows are built on [Gitea Actions](https://docs.gitea.com/usage/actions/overview) (similar to [GitHub Actions](https://github.com/features/actions)), providing a +familiar syntax and allowing you to leverage a wide range of third-party Actions. + + +## ⚙️ Qoherent-hosted runners + +Qoherent-hosted runners are workflow runners that Qoherent provides and manages to run your workflows and jobs in +RIA Hub Workflows. + +Why use Qoherent-hosted runners? +- Start running workflows right away, without the need to set up your own infrastructure. +- Qoherent maintains runners equipped with access to hardware and tools common for radio ML development, including +SDR testbeds and common embedded targets. + +If you want to learn more about the runners we have available, [contact us](https://www.qoherent.ai/contact/) directly. We can also provide +custom runners equipped with specific radio hardware and RAN software upon request. + +Want to register your own runner? No problem! Please refer to the RIA Hub documentation for more details. + + +## 🔍 Modulation Recognition + +In radio, the modulation scheme refers to the method used to encode information onto a carrier signal. Common schemes +such as BPSK, QPSK, and QAM vary the amplitude, phase, or frequency of the signal in structured ways to represent +digital data. These schemes are fundamental to nearly all wireless communication systems, enabling efficient and +reliable transmission over different channels and under various noise conditions. + +Machine learning-based modulation classification helps identify which modulation scheme is being used, especially +in scenarios where prior knowledge of the signal format is unavailable or unreliable. Traditional methods often rely +on expert-designed features and rule-based algorithms, which can struggle in real-world environments with multipath, +interference, or hardware impairments. In contrast, ML-based approaches can learn complex patterns directly from +raw signal data, offering higher robustness and adaptability. This is particularly valuable in applications like +cognitive radio, spectrum monitoring, electronic warfare, and autonomous communication systems, where accurate and +fast modulation recognition is critical. + + +## 🚀 Getting started + +1. Fork the project repo, using the button in the upper right hand corner. + + +2. Enable Workflows (*Settings → Advanced Settings → Enable Repository Actions*). +_TODO: Remove this point once default units have been updated to include actions in forks_ + + +3. Check for available runners. The runner management tab can found at the top of the 'Workflows' tab in your +repository. If no runners are available, you'll need to register one before proceeding. + + +4. Configure Git API credentials, if not suitable credentials are already set. This is required for accessing Utils +in the job container. This requires three steps: + + - Create a personal access token with the following permissions: `read:packages` (*User Settings → Applications → Manage Access Tokens*). + + - Create a Workflow Variable `RIAHUB_USER` with your RIA Hub username (*Repo Settings → Actions → Variables Management*) + + - Create a Workflow Secret `RIAHUB_TOKEN` with the token created above (*Repo Settings → Actions → Secrets Management*) + + _TODO: Remove this point once the Utils wheel file has been added to this project._ + + +5. Clone down the project. For example: ```commandline -git clone https://github.com/yourorg/modrec-workflow.git +git clone https://git.riahub.ai/user/modrec-workflow.git cd modrec-workflow ``` -2. Configure the Workflow - -All workflow parameters (data paths, model architecture, training settings) are set in 'conf/app.yaml' - -Example: -```commandline -dataset: - input_dir: data/recordings - num_slices: 8 - train_split: 0.8 - val_split : 0.2 +6. Set the workflow runner in `.riahub/workflows/workflow.yaml`. The runner is set on line 13: +```yaml +runs-on: ubuntu-latest-2080 ``` - -### Configure GitHub Secrets - -Before running the pipeline, add the following repository secrets in GitHub (Settings → Secrets and variables → Actions): - -- **RIAHUB_USER**: Your RIA Hub username. -- **RIAHUB_TOKEN**: RIA Hub access token with `read:packages` scope (from your RIA Hub account **Settings → Access Tokens**). -- **CLONER_TOKEN**: Personal access token for `stark_cloner_bot` with `read_repository` scope (from your on-prem Git server user settings). - -Once secrets are configured, you can run the pipeline: +**Note:** We recommend running this demo on a GPU-enabled runner. If a GPU runner is not available, you can still run +the workflow, but we suggest reducing the number of training epochs to keep runtime reasonable. -3. Run the Pipeline -Once you update the changes to app.yaml, you can make any push or pull to your repo to start running the workflow - -## Artifacts Created -After Successful execution, the workflow produces serveral artifacts in the output -- dataset - - This is a folder containing to .h5 datasets called train and val -- Checkpoints - - Contains saved model checkpoints, each checkpoint includes the models learned weights at various stages of training -- ONNX File - - The ONNX file contains the trained model in a standardized format that allows it to be run efficiently across different platforms and deployment environments. -- JSON Trace File (*json) - - Captures a full trace of model training and inference perfomance for profiling and debugging - - Useful for identifying performance bottlenecks, optimizing resource usage, and tracking metadata -- ORT File (*ort) - - This is an ONNX Runtime (ORT) model file, optimized for fast inference on various platforms - - Why is it Useful? - - You can deploy this file on edge devices, servers or integrate it into the production systems for real-time signal classification - - ORT files are class-platform and allow easy inference acceleration using ONNX Runtime +7. (Optional) Configure the workflow. All parameters—including file paths, model architecture, and training +settings—are set in `conf/app.yaml`. Want to jump right in? No problem, the default configuration is suitable. -## How to View the JSON Trace File - -Access this [link](https://ui.perfetto.dev/) -Click on Open Trace File -> Select your specific JSON trace file -Explore detailed visualizations of performance metrics, timelines, and resource usage to diagnose bottlenecks and optimize your workflow. +8. Push changes. This will automatically trigger the workflow. You can monitor workflow progress under the 'Workflows' +tab in the repository. - -## Submiting Issues -Found a bug or have a feature request? -Please submit an issue via the GitHub Issues page. -When reporting bugs, include: -Steps to reproduce - - Error logs and screenshots (if applicable) - - Your app.yaml configuration (if relevant) +9. Inspect the workflow output. You can expand and collapse individual steps to view terminal output. A check +mark indicates that the step completed successfully. +10. Inspect the workflow artifacts. Additional information on workflow artifacts can be found in the next section. -## Developer Details -Coding Guidelines: - Follow PEP 8 for Python code style. - Include type annotations for all public functions and methods. - Write clear docstrings for modules, classes, and functions. - Use descriptive commit messages and reference issue numbers when relevant. -Contributing - All contributions must be reviewed via pull requests. - Run all tests and ensure code passes lint checks before submission. \ No newline at end of file + +## Workflow artifacts + +This workflow generates several artifacts, including: + +- `recordings`: Folder of synthetic signal recordings. + + +- `dataset`: The training and validation datasets: `train.h5` and `val.h5`, respectively. + + +- `checkpoints`: Saved model checkpoints. Each checkpoint contains the model’s learned weights at various +stages of training. + + +- `onnx-file`: The trained model as an [ONNX](https://onnx.ai/) graph. + + +- `ort-file`: Model in `.ORT` format, recommended for edge deployments. (`.ORT` files are optimized and serialized +by [ONNX Runtime](https://onnxruntime.ai/) for more efficient loading and execution.) + + +- `profile-data`: Model execution traces, in JSON format. See the section below for instructions on how to inspect the +trace using Perfetto. + + +## 📊 Inspecting the model trace using Perfetto + +[Perfetto](https://ui.perfetto.dev/) is an open-source trace visualization tool developed by Google. It provides a powerful web-based +interface for inspecting model execution traces. Perfetto is especially useful for identifying bottlenecks. + +To inspect model trace, navigate to Perfetto. Select *Navigation → Open trace file*, and choose the JSON trace file +includes in the `profile-data` artifact. + + +## 🤝 Contribution + +We welcome contributions from the community! Whether it's an enhancement, bug fix, or new tutorial, your +input is valuable. To get started, please [contact us](https://www.qoherent.ai/contact/) directly, we're looking forward to collaborating with +you. 🚀 + +If you encounter any issues or to report a security vulnerability, please submit a [bug report](https://git.riahub.ai/qoherent/modrec-workflow/issues). + +Qoherent is dedicated to fostering a friendly, safe, and inclusive environment for everyone. For more information on +our commitment to diversity, please refer to our [Diversity Statement](https://github.com/qoherent/.github/blob/main/docs/DIVERSITY_STATEMENT.md). + +We kindly insist that all contributors review and adhere to our [Code of Conduct](https://github.com/qoherent/.github/blob/main/docs/CODE_OF_CONDUCT.md) and that all code contributors +review our [Coding Guidelines](https://github.com/qoherent/.github/blob/main/docs/CODING.md). + + +## 🖊️ Authorship + +This demonstration was developed by [Liyu Xiao](https://www.linkedin.com/in/liyu-xiao-593176206/) during his summer co-op term at Qoherent. + +If you like this project, don’t forget to give it a star! ⭐ + + +## 📄 License + +This example is **free and open-source**, released under [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.en.html). + +Alternative licensing options are available. Alternative licensing options are available. Please [contact us](https://www.qoherent.ai/contact/) +for further details. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..7973e67 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,3 @@ +To report a security vulnerability, please submit a bug report to this project's issue tracker. Be sure to explicitly +state that the issue concerns a security vulnerability. This helps us classify and manage security reports separately +from general issues. diff --git a/conf/app.yaml b/conf/app.yaml index 80a52af..c1f1c4c 100644 --- a/conf/app.yaml +++ b/conf/app.yaml @@ -1,20 +1,16 @@ -general: - # Run mode. Options are 'prod' or 'dev'. - run_mode: prod - dataset: - #number of slices you want to split each recording into - num_slices: 8 + # Seed for the random number generator, used for signal generation + seed: 42 - #training/val split between the 2 data sets - train_split: 0.8 - val_split : 0.2 + # Number of samples per recording + recording_length: 1024 - #used to initialize a random number generator. - seed: 25 - - #multiple modulations to contain in the dataset - modulation_types: [bpsk, qpsk, qam16, qam64] + # List of signal modulation schemes to include in the dataset + modulation_types: + - bpsk + - qpsk + - qam16 + - qam64 # Rolloff factor for pulse shaping filter (0 < beta <= 1) beta: 0.3 @@ -23,20 +19,18 @@ dataset: sps: 4 # SNR sweep range: start, stop (exclusive), and step (in dB) - snr_start: -6 # Start value of SNR sweep (in dB) - snr_stop: 13 # Stop value (exclusive) of SNR sweep (in dB) - snr_step: 3 # Step size for SNR sweep (in dB) + snr_start: -6 + snr_stop: 13 + snr_step: 3 - # Number of iterations (samples) per modulation and SNR combination + # Number of iterations (signal recordings) per modulation and SNR combination num_iterations: 3 - # Number of samples per generated recording - recording_length: 1024 - - # Settings for each modulation scheme - # Keys must match entries in `modulation_types` - # - `num_bits_per_symbol`: how many bits each symbol encodes (e.g., 1 for BPSK, 4 for 16-QAM) - # - `constellation_type`: type of modulation (e.g., "psk", "qam", "fsk", "ofdm") + # Modulation scheme settings; keys must match the `modulation_types` list above + # Each entry includes: + # - num_bits_per_symbol: bits encoded per symbol (e.g., 1 for BPSK, 4 for 16-QAM) + # - constellation_type: modulation category (e.g., "psk", "qam", "fsk", "ofdm") + # TODO: Combine entries for 'modulation_types' and 'modulation_settings' modulation_settings: bpsk: num_bits_per_symbol: 1 @@ -51,20 +45,25 @@ dataset: num_bits_per_symbol: 6 constellation_type: qam + # Number of slices to cut from each recording + num_slices: 8 + # Training and validation split ratios; must sum to 1 + train_split: 0.8 + val_split : 0.2 training: - # Number of training samples processed together before the model updates its weights + # Number of training examples processed together before the model updates its weights batch_size: 256 # Number of complete passes through the training dataset during training epochs: 5 - # Learning rate: how much weights are updated after every batch - # Suggested range for fine-tuning: 1e-6 to 1e-4 + # Learning rate: step size for weight updates after each batch + # Recommended range for fine-tuning: 1e-6 to 1e-4 learning_rate: 1e-4 - # Whether to use GPU acceleration for training (if available) + # Enable GPU acceleration for training if available use_gpu: true # Dropout rate for individual neurons/layers (probability of dropping out a unit) @@ -73,13 +72,12 @@ training: # Drop path rate: probability of dropping entire residual paths (stochastic depth) drop_path_rate: 0.2 - # Weight decay (L2 regularization) to help prevent overfitting + # Weight decay (L2 regularization) coefficient to help prevent overfitting wd: 0.01 - app: - # Optimization style for ORT conversion. Options: 'Fixed', 'None' - optimization_style: Fixed + # Optimization style for ORT conversion; options: 'Fixed', 'None' + optimization_style: "Fixed" - # Target platform architecture. Common options: 'amd64', 'arm64' - target_platform: amd64 \ No newline at end of file + # Target platform architecture; common options: 'amd64', 'arm64' + target_platform: "amd64" diff --git a/helpers/app_settings.py b/helpers/app_settings.py index b019f92..8d3fd57 100644 --- a/helpers/app_settings.py +++ b/helpers/app_settings.py @@ -6,11 +6,6 @@ from typing import Dict import yaml -@dataclass -class GeneralConfig: - run_mode: str - - @dataclass class DataSetConfig: num_slices: int @@ -54,7 +49,6 @@ class AppSettings: config_data = yaml.safe_load(f) # Parse the loaded YAML into dataclass objects - self.general = GeneralConfig(**config_data["general"]) self.dataset = DataSetConfig(**config_data["dataset"]) self.training = TrainingConfig(**config_data["training"]) self.app = AppConfig(**config_data["app"]) diff --git a/scripts/onnx/convert_to_onnx.py b/scripts/application_packager/convert_to_onnx.py similarity index 90% rename from scripts/onnx/convert_to_onnx.py rename to scripts/application_packager/convert_to_onnx.py index 7a3d209..f022c39 100644 --- a/scripts/onnx/convert_to_onnx.py +++ b/scripts/application_packager/convert_to_onnx.py @@ -2,8 +2,8 @@ import os import numpy as np import torch +from scripts.model_builder.mobilenetv3 import RFClassifier, mobilenetv3 -from scripts.training.mobilenetv3 import mobilenetv3, RFClassifier from helpers.app_settings import get_app_settings @@ -12,8 +12,8 @@ def convert_to_onnx(ckpt_path: str, fp16: bool = False) -> None: Convert a PyTorch model to ONNX format. Parameters: - output_path (str): The path to save the converted ONNX model. - fp16 (bool): 16 float point percision + ckpt_path (str): The path to save the converted ONNX model. + fp16 (bool): 16 float point precision """ settings = get_app_settings() @@ -68,8 +68,6 @@ def convert_to_onnx(ckpt_path: str, fp16: bool = False) -> None: if __name__ == "__main__": - settings = get_app_settings() - model_checkpoint = "inference_recognition_model.ckpt" print("Converting to ONNX...") diff --git a/scripts/ort/convert_to_ort.py b/scripts/application_packager/convert_to_ort.py similarity index 99% rename from scripts/ort/convert_to_ort.py rename to scripts/application_packager/convert_to_ort.py index 593268d..55782d7 100644 --- a/scripts/ort/convert_to_ort.py +++ b/scripts/application_packager/convert_to_ort.py @@ -1,4 +1,5 @@ import subprocess + from helpers.app_settings import get_app_settings settings = get_app_settings() diff --git a/scripts/onnx/profile_onnx.py b/scripts/application_packager/profile_onnx.py similarity index 97% rename from scripts/onnx/profile_onnx.py rename to scripts/application_packager/profile_onnx.py index 7f6ff04..8ef12ed 100644 --- a/scripts/onnx/profile_onnx.py +++ b/scripts/application_packager/profile_onnx.py @@ -1,9 +1,9 @@ -import onnxruntime as ort -import numpy as np -from helpers.app_settings import get_app_settings +import json import os import time -import json + +import numpy as np +import onnxruntime as ort def profile_onnx_model( @@ -84,6 +84,5 @@ def profile_onnx_model( if __name__ == "__main__": - settings = get_app_settings() output_path = os.path.join("onnx_files", "inference_recognition_model.onnx") profile_onnx_model(output_path) diff --git a/scripts/dataset_building/data_gen.py b/scripts/dataset_manager/data_gen.py similarity index 99% rename from scripts/dataset_building/data_gen.py rename to scripts/dataset_manager/data_gen.py index 0fac831..6cbbf73 100644 --- a/scripts/dataset_building/data_gen.py +++ b/scripts/dataset_manager/data_gen.py @@ -1,7 +1,9 @@ -from utils.data import Recording -import numpy as np -from utils.signal import block_generator import argparse + +import numpy as np +from utils.data import Recording +from utils.signal import block_generator + from helpers.app_settings import get_app_settings settings = get_app_settings().dataset diff --git a/scripts/dataset_building/produce_dataset.py b/scripts/dataset_manager/produce_dataset.py similarity index 98% rename from scripts/dataset_building/produce_dataset.py rename to scripts/dataset_manager/produce_dataset.py index b2e65c2..55207d9 100644 --- a/scripts/dataset_building/produce_dataset.py +++ b/scripts/dataset_manager/produce_dataset.py @@ -1,7 +1,11 @@ -import os, h5py, numpy as np +import os from typing import List -from utils.io import from_npy + +import h5py +import numpy as np from split_dataset import split, split_recording +from utils.io import from_npy + from helpers.app_settings import DataSetConfig, get_app_settings meta_dtype = np.dtype( @@ -46,8 +50,6 @@ def write_hdf5_file(records: List, output_path: str, dataset_name: str = "data") ) first_rec, _ = records[0] # records[0] is a tuple of (data, md) - sample = first_rec - shape, dtype = sample.shape, sample.dtype with h5py.File(output_path, "w") as hf: data_arr = np.stack([rec[0] for rec in records]) diff --git a/scripts/dataset_building/split_dataset.py b/scripts/dataset_manager/split_dataset.py similarity index 98% rename from scripts/dataset_building/split_dataset.py rename to scripts/dataset_manager/split_dataset.py index 732c84b..0f820b1 100644 --- a/scripts/dataset_building/split_dataset.py +++ b/scripts/dataset_manager/split_dataset.py @@ -1,6 +1,7 @@ import random from collections import defaultdict -from typing import List, Tuple, Dict +from typing import Dict, List, Tuple + import numpy as np diff --git a/scripts/training/cm_plotter.py b/scripts/model_builder/cm_plotter.py similarity index 99% rename from scripts/training/cm_plotter.py rename to scripts/model_builder/cm_plotter.py index 429293c..13770e3 100644 --- a/scripts/training/cm_plotter.py +++ b/scripts/model_builder/cm_plotter.py @@ -1,5 +1,6 @@ -import numpy as np from typing import Optional + +import numpy as np from matplotlib import pyplot as plt from sklearn.metrics import confusion_matrix diff --git a/scripts/training/mobilenetv3.py b/scripts/model_builder/mobilenetv3.py similarity index 94% rename from scripts/training/mobilenetv3.py rename to scripts/model_builder/mobilenetv3.py index 83556bd..9de7f27 100644 --- a/scripts/training/mobilenetv3.py +++ b/scripts/model_builder/mobilenetv3.py @@ -1,8 +1,8 @@ -import numpy as np -import torch -import timm -from torch import nn import lightning as L +import numpy as np +import timm +import torch +from torch import nn sizes = [ "mobilenetv3_large_075", @@ -24,11 +24,9 @@ class SqueezeExcite(nn.Module): def __init__( self, in_chs, - se_ratio=0.25, reduced_base_chs=None, act_layer=nn.SiLU, gate_fn=torch.sigmoid, - divisor=1, **_, ): super(SqueezeExcite, self).__init__() @@ -77,13 +75,6 @@ class GBN(torch.nn.Module): self.act = act def forward(self, x): - # chunks = x.chunk(int(np.ceil(x.shape[0] / self.virtual_batch_size)), 0) - # res = [self.bn(x_) for x_ in chunks] - # return self.drop(self.act(torch.cat(res, dim=0))) - # x = self.bn(x) - # x = self.act(x) - # x = self.drop(x) - # return x return self.drop(self.act(self.bn(x))) diff --git a/scripts/training/modulation_dataset.py b/scripts/model_builder/modulation_dataset.py similarity index 98% rename from scripts/training/modulation_dataset.py rename to scripts/model_builder/modulation_dataset.py index 5f65dc5..5826739 100644 --- a/scripts/training/modulation_dataset.py +++ b/scripts/model_builder/modulation_dataset.py @@ -1,10 +1,12 @@ -import sys, os +import os +import sys sys.path.insert(0, os.path.abspath("../..")) # or ".." if needed +import h5py import numpy as np import torch from torch.utils.data import Dataset -import h5py + from helpers.app_settings import get_app_settings settings = get_app_settings() diff --git a/scripts/training/plot_data.py b/scripts/model_builder/plot_data.py similarity index 93% rename from scripts/training/plot_data.py rename to scripts/model_builder/plot_data.py index 531c684..8acc1ff 100644 --- a/scripts/training/plot_data.py +++ b/scripts/model_builder/plot_data.py @@ -1,15 +1,15 @@ import os -import torch + import numpy as np +import torch from sklearn.metrics import classification_report os.environ["NNPACK"] = "0" from matplotlib import pyplot as plt +from mobilenetv3 import RFClassifier, mobilenetv3 +from modulation_dataset import ModulationH5Dataset -from scripts.training.mobilenetv3 import mobilenetv3, RFClassifier from helpers.app_settings import get_app_settings -from cm_plotter import plot_confusion_matrix -from scripts.training.modulation_dataset import ModulationH5Dataset def load_validation_data(): @@ -141,5 +141,4 @@ def plot_confusion_matrix_with_counts( if __name__ == "__main__": settings = get_app_settings() - ckpt_path = os.path.join("checkpoint_files", "inference_recognition_model.ckpt") - evaluate_checkpoint(ckpt_path) + evaluate_checkpoint(os.path.join("checkpoint_files", "inference_recognition_model.ckpt")) diff --git a/scripts/training/train.py b/scripts/model_builder/train.py similarity index 99% rename from scripts/training/train.py rename to scripts/model_builder/train.py index 5d334ec..560a9d5 100644 --- a/scripts/training/train.py +++ b/scripts/model_builder/train.py @@ -1,14 +1,16 @@ -import sys, os +import os +import sys os.environ["NNPACK"] = "0" import lightning as L -from lightning.pytorch.callbacks import ModelCheckpoint +import mobilenetv3 import torch import torch.nn.functional as F import torchmetrics -from helpers.app_settings import get_app_settings +from lightning.pytorch.callbacks import ModelCheckpoint from modulation_dataset import ModulationH5Dataset -import mobilenetv3 + +from helpers.app_settings import get_app_settings script_dir = os.path.dirname(os.path.abspath(__file__)) data_dir = os.path.abspath(os.path.join(script_dir, "..")) diff --git a/wheels/utils-0.1.2.dev0-py3-none-any (3).whl b/wheels/utils-0.1.2.dev0-py3-none-any (3).whl new file mode 100644 index 0000000..d065a8b Binary files /dev/null and b/wheels/utils-0.1.2.dev0-py3-none-any (3).whl differ