diff --git a/.flake8 b/.flake8
deleted file mode 100644
index d3bb141..0000000
--- a/.flake8
+++ /dev/null
@@ -1,3 +0,0 @@
-[flake8]
-ignore = E203, E731, W503
-max-line-length = 120
\ No newline at end of file
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
index 148047b..f7306ba 100644
--- a/.github/workflows/python-publish.yml
+++ b/.github/workflows/python-publish.yml
@@ -2,42 +2,46 @@ name: Master Deploy
on:
push:
- branches:
- - 'master'
+ branches:
+ - "master"
permissions:
contents: write
jobs:
deploy:
-
- runs-on: ubuntu-latest
-
+ runs-on: ubuntu-24.04
steps:
- - uses: actions/checkout@v3
- - name: Set up Python
- uses: actions/setup-python@v3
- with:
- python-version: '3.7'
- - name: Install dependencies and test
- run: |
- python -m pip install pip==22.2.2 setuptools==65.3.0 wheel==0.37.1
- pip install poetry==1.1.15
- poetry install
- poetry run coverage run -m pytest
- - name: Generate Documentation
- run: |
- poetry run coverage html -d docs/coverage
- poetry run pdoc --html --force deeprecsys -o docs/api
- - name: Version Bump
- run: |
- poetry version patch
- git config --global user.name 'Github Actions'
- git config --global user.email 'luksfarris@users.noreply.github.com'
- git commit -am "Bump to version $(poetry version -s)"
- git push
- - name: Build package and publish
- run: |
- poetry build
- poetry config pypi-token.pypi ${{ secrets.PYPI_KEY }}
- poetry publish
+ - uses: actions/checkout@v3
+ - name: Set up Python
+ uses: actions/setup-python@v3
+ with:
+ python-version: "3.11"
+ - name: Install Task
+ uses: arduino/setup-task@v2
+ with:
+ version: 3.37.1
+ - name: Install dependencies and test
+ run: |
+ task setup
+ venv/bin/poetry run pre-commit uninstall
+ task test
+ - name: Generate Documentation
+ run: |
+ task docs
+ - name: Version Bump
+ run: |
+ task bump
+ git push
+ git push origin v$(task version)
+ - name: Build package and publish
+ env:
+ PYPI_KEY: ${{ secrets.PYPI_KEY }}
+ run: |
+ task publish
+ - name: Publish Release
+ env:
+ GH_TOKEN: ${{ github.token }}
+ REPO_NAME: ${{ github.repository }}
+ TAG: $(task version)
+ run: gh release create "$TAG" --repo="$REPO_NAME" --title="$TAG" --generate-notes
\ No newline at end of file
diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml
new file mode 100644
index 0000000..d409867
--- /dev/null
+++ b/.github/workflows/website.yml
@@ -0,0 +1,44 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+ # Runs on pushes targeting the default branch that affect the docs folder
+ push:
+ branches: ["master"]
+ paths: ['docs/**']
+
+ # Allows you to run this workflow manually from the Actions tab
+ workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+ contents: read
+ pages: write
+ id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+ group: "pages"
+ cancel-in-progress: false
+
+jobs:
+ # Single deploy job since we're just deploying
+ deploy:
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ - name: Setup Pages
+ uses: actions/configure-pages@v5
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v3
+ with:
+ # Upload entire repository
+ path: './docs'
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v4
\ No newline at end of file
diff --git a/.gitmodules b/.gitmodules
deleted file mode 100644
index e69de29..0000000
diff --git a/.idea/.gitignore b/.idea/.gitignore
deleted file mode 100644
index 26d3352..0000000
--- a/.idea/.gitignore
+++ /dev/null
@@ -1,3 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml
diff --git a/.idea/deeprecsys.iml b/.idea/deeprecsys.iml
deleted file mode 100644
index 798f2f9..0000000
--- a/.idea/deeprecsys.iml
+++ /dev/null
@@ -1,17 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
deleted file mode 100644
index 092eb8d..0000000
--- a/.idea/inspectionProfiles/Project_Default.xml
+++ /dev/null
@@ -1,32 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml
deleted file mode 100644
index 105ce2d..0000000
--- a/.idea/inspectionProfiles/profiles_settings.xml
+++ /dev/null
@@ -1,6 +0,0 @@
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/misc.xml b/.idea/misc.xml
deleted file mode 100644
index 654090a..0000000
--- a/.idea/misc.xml
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-
-
\ No newline at end of file
diff --git a/.idea/modules.xml b/.idea/modules.xml
deleted file mode 100644
index 5ca9079..0000000
--- a/.idea/modules.xml
+++ /dev/null
@@ -1,8 +0,0 @@
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
deleted file mode 100644
index 49d3c22..0000000
--- a/.idea/vcs.xml
+++ /dev/null
@@ -1,7 +0,0 @@
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 4343c37..13f0601 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,31 +1,12 @@
repos:
- - repo: https://github.com/ambv/black
- rev: 21.9b0
+ - repo: https://github.com/astral-sh/ruff-pre-commit
+ rev: v0.4.4
hooks:
- - id: black
- language_version: python3.6
- - repo: https://github.com/PyCQA/flake8
- rev: 6.0.0
- hooks:
- - id: flake8
- additional_dependencies: ["flake8-bugbear", mccabe, "pep8-naming"]
- args: ["--max-complexity=5"]
- - repo: https://github.com/pycqa/isort
- rev: 5.8.0
- hooks:
- - id: isort
- name: isort (python)
- args: ["--profile=black"]
- - repo: https://github.com/PyCQA/pydocstyle
- rev: 6.1.1
- hooks:
- - id: pydocstyle
- args:
- [
- "--ignore=D100,D104,D203,D205,D209,D213,D400,D415",
- "--match=deeprecsys/rl/.*",
- ]
- additional_dependencies: [toml]
+ - id: ruff
+ args: [--fix]
+ types_or: [python, jupyter]
+ - id: ruff-format
+ types_or: [python, jupyter]
- repo: https://github.com/pre-commit/mirrors-mypy
rev: v0.930
hooks:
diff --git a/LICENSE b/LICENSE
index 9f7aa0a..f288702 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,21 +1,674 @@
-MIT License
-
-Copyright (c) 2021 Lucas Farris
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 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 General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is 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. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ 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.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ 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 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. Use with the GNU Affero General Public License.
+
+ 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 Affero 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 special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU 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 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 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 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 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 General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ 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 GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
diff --git a/README.md b/README.md
index 7810c64..be7a2fc 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,36 @@
-# PyDeepRecSys
+# Deep RecSys
-**pydeeprecsys** is maily an environment that simulates a Reinforcement Learning environment, using realistic Recommender System data. It includes a set of tools and agents.
+`deeprecsys` is an opentool belt to speed up the development of moderndata science projects at an enterprise level.
-### Getting Started
+These words were chosen very carefully, and by them we mean:
+- **Open**: we rely on OSS and distribute openly with [a GNU GPLv3 license](./LICENSE) that won't change in the future. The official distribution channels are pypi ([see deeprecsys at pypi](https://pypi.org/project/deeprecsys/)) and GitHub ([see deeprecsys at Github](https://github.com/luksfarris/deeprecsys)).
+- **Tool belt**: this project contains code that may extract, process, analyse, aggregate, test, and present data.
+- **Modern**: the code will be updated as much as possible to the newest versions, as long as they are stable and don't break pre-existing functionality.
+- **Data Science**: This project will contain a mixture of data engineering, machine learning engineering, data analysis, and data visualization.
+- **Enterprise**: The code deployed here will likely have been battle-tested by large organizations with millions of customers. Unless stated, it is production-ready. All code including dependencies is audited and secure.
-For instructions on setting up, check out the [Getting Started Wiki Page](https://github.com/luksfarris/pydeeprecsys/wiki/Getting-Started).
+## Historical Note
-This project is a WIP. It is provided "as is" under the MIT license.
+If you're here from the research piece [Optimized Recommender Systems with Deep Reinforcement Learning](https://arxiv.org/abs/2110.03039), please checkout the old branch `origin/thesis` for reproducibility. The README should contain instructions to get you started.
+## Installation and usage
-### Dev Setup
+Installation depends on your framework, so you may need to adapt this. Here's an example using pip:
-Similar to what's in the CI workflow:
```
-python3 -m venv venv
-python -m pip install pip==22.2.2 setuptools==65.3.0 wheel==0.37.1
-pip install poetry==1.1.15
-poetry install
-```
\ No newline at end of file
+pip install deeprecsys
+```
+
+## For Developers
+
+### Source Control
+
+All source control is done in `git`, via GitHub. Make sure you have a modern version of git installed. For instance, you can checkout the project using SSH with:
+
+```
+git clone git@github.com:luksfarris/deeprecsys.git
+```
+
+### Automation
+
+All scripts are written using Taskfile. You can install it following [Task's instructions](https://taskfile.dev/installation/). The file with all the tasks is `Taskfile.yml`.
\ No newline at end of file
diff --git a/Taskfile.yml b/Taskfile.yml
new file mode 100644
index 0000000..7e626bb
--- /dev/null
+++ b/Taskfile.yml
@@ -0,0 +1,66 @@
+version: "3"
+
+env:
+ VENV_FOLDER: venv
+ EXEC_FOLDER: bin
+
+tasks:
+ setup:
+ desc: Sets up the virtual environment and builds the dependencies
+ cmds:
+ - python3.11 -m venv ${VENV_FOLDER}
+ - ${VENV_FOLDER}/${EXEC_FOLDER}/pip install setuptools==68.0.0 wheel==0.43.0 pip==24.0
+ - ${VENV_FOLDER}/${EXEC_FOLDER}/pip install poetry==1.8.3
+ - task: dependencies
+ - ${VENV_FOLDER}/${EXEC_FOLDER}/poetry run pre-commit install
+
+ version:
+ desc: Shows the version of the package
+ silent: true
+ cmds:
+ - echo $(${VENV_FOLDER}/${EXEC_FOLDER}/poetry version -s)
+
+ dependencies:
+ internal: true
+ cmds:
+ - ${VENV_FOLDER}/${EXEC_FOLDER}/poetry install --all-extras
+
+ lint:
+ desc: Runs all the pre-commit hooks
+ cmds:
+ - ${VENV_FOLDER}/${EXEC_FOLDER}/poetry run pre-commit run --all-files
+
+ test:
+ desc: Runs all the tests
+ cmds:
+ - ${VENV_FOLDER}/${EXEC_FOLDER}/poetry run coverage run -m pytest tests
+
+ docs:
+ desc: Generates the documentation
+ cmds:
+ - ${VENV_FOLDER}/${EXEC_FOLDER}/poetry run coverage html -d docs/coverage
+ - ${VENV_FOLDER}/${EXEC_FOLDER}/poetry run pdoc --html --force deeprecsys -o docs/api
+
+ bump:
+ desc: Bumps the version of the package
+ env:
+ VERSION: $(task version)
+ cmds:
+ - ${VENV_FOLDER}/${EXEC_FOLDER}/poetry version patch
+ - git config --global user.name 'Github Actions'
+ - git config --global user.email 'luksfarris@users.noreply.github.com'
+ - git commit -am "Bump to version ${VERSION}"
+ - git tag -a v${VERSION} -m "Release version ${VERSION}"
+
+ build:
+ desc: Builds the package
+ internal: true
+ cmds:
+ - ${VENV_FOLDER}/${EXEC_FOLDER}/poetry build
+
+ publish:
+ desc: Builds the package and publishes it to PyPI
+ cmds:
+ - task: build
+ - ${VENV_FOLDER}/${EXEC_FOLDER}/poetry config pypi-token.pypi ${PYPI_KEY}
+ - ${VENV_FOLDER}/${EXEC_FOLDER}/poetry publish
\ No newline at end of file
diff --git a/deeprecsys/movielens_fairness_env.py b/deeprecsys/movielens_fairness_env.py
deleted file mode 100644
index 93d7e5a..0000000
--- a/deeprecsys/movielens_fairness_env.py
+++ /dev/null
@@ -1,199 +0,0 @@
-import functools
-import math
-import os
-from typing import Any, Dict, List, Optional, Tuple, Union
-
-import attr
-import numpy as np
-from gym import Env, Space
-from gym.envs.registration import register
-from gym.spaces import Box, Discrete
-from mlfairnessgym.environments.recommenders import movie_lens_dynamic as movie_lens
-from mlfairnessgym.environments.recommenders import movie_lens_utils, recsim_samplers
-from numpy.core.multiarray import ndarray
-from recsim.simulator import recsim_gym
-from recsim.simulator.recsim_gym import RecSimGymEnv
-
-_env_specs = {
- "id": "MovieLensFairness-v0",
- "entry_point": "deeprecsys.movielens_fairness_env:MovieLensFairness",
- "max_episode_steps": 50,
-}
-register(**_env_specs)
-
-
-class MovieLensFairness(Env):
- """MovieLens + MLFairnessGym + Recsim + Gym environment"""
-
- def __init__(self, slate_size: int = 1, seed: Optional[int] = None):
- self.slate_size = slate_size
- self.internal_env = self.prepare_environment()
- self._rng = np.random.RandomState(seed=seed)
- self.ndcg: List[float] = []
- self.dcg: List[float] = []
-
- def _get_product_relevance(self, product_id: int) -> float:
- """Relevance in range (0,1)"""
- topic_affinity = (
- self.internal_env.environment.user_model._user_state.topic_affinity
- )
- movie_vector = [
- d.movie_vec
- for d in self.internal_env.environment._document_sampler._corpus
- if d._doc_id == product_id
- ][0]
- return np.clip(
- np.dot(movie_vector, topic_affinity),
- movie_lens.User.MIN_SCORE,
- movie_lens.User.MAX_SCORE,
- )
-
- def _get_dcg(self, relevances: List[float]) -> float:
- return sum([relevances[i] / math.log(i + 2, 2) for i in range(len(relevances))])
-
- def _calculate_ndcg(self, slate_product_ids: List[int]) -> None:
- relevances = [self._get_product_relevance(p) for p in slate_product_ids]
- dcg = self._get_dcg(relevances)
- self.dcg.append(dcg)
- ideal_relevances = [movie_lens.User.MAX_SCORE for _ in range(len(relevances))]
- idcg = self._get_dcg(ideal_relevances)
- self.ndcg.append(dcg / idcg)
-
- def step(self, action: Union[int, List[int]]) -> Tuple:
- """Normalize reward and flattens/normalizes state"""
- if isinstance(action, (list, np.ndarray)):
- self._calculate_ndcg(action)
- state, reward, done, info = self.internal_env.step(action)
- encoded_state, info = self.movielens_state_encoder(state, action, info)
- return encoded_state, reward / 5, done, info
- else:
- state, reward, done, info = self.internal_env.step([action])
- encoded_state, info = self.movielens_state_encoder(state, [action], info)
- return encoded_state, reward / 5, done, info
-
- def reset(self) -> List:
- """flattens/normalizes state"""
- state = self.internal_env.reset()
- self.ndcg = []
- self.dcg = []
- encoded_state, _ = self.movielens_state_encoder(state, [], {})
- return encoded_state
-
- def render(self, mode: str = "human", close: bool = False) -> Any:
- return self.internal_env.render(mode)
-
- @property
- def action_space(self) -> Space:
- if self.slate_size == 1:
- return Discrete(self.internal_env.action_space.nvec[0])
- else:
- return self.internal_env.action_space
-
- @property
- def reward_range(self) -> Tuple:
- return self.internal_env.reward_range
-
- @property
- def observation_space(self) -> Space:
- return Box(low=0, high=1.0, shape=(25,), dtype=np.float32)
-
- def movielens_state_encoder(
- self, state: dict, action_slate: List[int], info: dict
- ) -> Tuple[ndarray, Dict]:
- """if the slate size is > 1, we need to guarantee the Single choice (SC)
- assumption, as described in the paper `SLATEQ: A Tractable Decomposition
- for Reinforcement Learning withRecommendation Sets`
- TODO: by randomly selecting one of the interactions?
- """
- user_features = state["user"]
- response_features = state["response"]
- doc_features = [
- state["doc"][str(action_slate[i])]["genres"]
- for i in range(len(action_slate))
- ]
- if self.slate_size > 1:
- if response_features:
- chosen_action = self._rng.choice(self.slate_size)
- response_features = (response_features[chosen_action],)
- info["chosen_action"] = chosen_action
- if doc_features:
- doc_features = [doc_features[self._rng.choice(self.slate_size)]]
-
- refined_state: Dict[Union[str, Tuple], Any] = {
- "user": user_features,
- "response": response_features,
- "slate_docs": doc_features,
- }
- # flattens the state
- flat_state = np.array(
- [
- refined_state["user"]["sex"],
- refined_state["user"]["age"],
- refined_state["user"]["occupation"],
- refined_state["user"]["zip_code"],
- *(
- refined_state["slate_docs"][0]
- if refined_state["slate_docs"]
- else ([0] * 19)
- ),
- (refined_state.get("response") or ({},))[0].get("rating", 0), # type: ignore
- (refined_state.get("response") or ({},))[0].get("violence_score", 0), # type: ignore
- ]
- )
- return flat_state, info
-
- def slate_action_selector(self, q_vals: List[float]) -> List[float]:
- """Gets the index of the top N highest elements in the predictor array."""
- return np.argsort(q_vals)[-self.slate_size :][::-1]
-
- def prepare_environment(self) -> RecSimGymEnv:
- current_path = os.path.dirname(__file__)
- data_dir = os.path.join(current_path, "../output")
- embeddings_path = os.path.join(
- current_path,
- "../mlfairnessgym/environments/recommenders/movielens_factorization.json",
- )
- env_config = movie_lens.EnvConfig(
- seeds=movie_lens.Seeds(0, 0),
- data_dir=data_dir,
- embeddings_path=embeddings_path,
- )
- initial_embeddings = movie_lens_utils.load_embeddings(env_config)
- # user constructor
- user_ctor = functools.partial(
- movie_lens.User, **attr.asdict(env_config.user_config)
- )
- dataset = movie_lens_utils.Dataset(
- env_config.data_dir,
- user_ctor=user_ctor,
- movie_ctor=movie_lens.Movie,
- response_ctor=movie_lens.Response,
- embeddings=initial_embeddings,
- )
- # the SingletonSampler will sample each movie once sequentially
- document_sampler = recsim_samplers.SingletonSampler(
- dataset.get_movies(), movie_lens.Movie
- )
- user_sampler = recsim_samplers.UserPoolSampler(
- seed=env_config.seeds.user_sampler,
- users=dataset.get_users(),
- user_ctor=user_ctor,
- )
- user_model = movie_lens.UserModel(
- user_sampler=user_sampler,
- seed=env_config.seeds.user_model,
- )
- env = movie_lens.MovieLensEnvironment(
- user_model,
- document_sampler,
- num_candidates=document_sampler.size(),
- slate_size=self.slate_size,
- resample_documents=False,
- )
- _ = env.reset()
- reward_aggregator = functools.partial(
- movie_lens.multiobjective_reward,
- lambda_non_violent=env_config.lambda_non_violent,
- )
- recsim_env = recsim_gym.RecSimGymEnv(env, reward_aggregator)
- return recsim_env
diff --git a/deeprecsys/neural_networks/base_network.py b/deeprecsys/neural_networks/base_network.py
index f6236cd..314c152 100644
--- a/deeprecsys/neural_networks/base_network.py
+++ b/deeprecsys/neural_networks/base_network.py
@@ -27,21 +27,21 @@ def load(self, path: str) -> None:
"""Read the model's parameters from the given path."""
self.load_state_dict(load(path))
- def soft_parameter_update(
- self, source_network: Module, update_rate: float = 0.0
- ) -> None:
+ def soft_parameter_update(self, source_network: Module, update_rate: float = 0.0) -> None:
"""When using target networks, this method updates the parameters of the current network
using the parameters of the given source network. The update_rate is a float in
range (0,1) and controls how the update affects the target (self). update_rate=0
means a full deep copy, and update_rate=1 means the target does not update
at all. This parameter is usually called Tau. This method is usually called
- an exponential moving average update."""
- for t, s in zip(self.parameters(), source_network.parameters()):
+ an exponential moving average update.
+ """
+ for t, s in zip(self.parameters(), source_network.parameters(), strict=False):
t.data.copy_(t.data * (1.0 - update_rate) + s.data * update_rate)
def run_backpropagation(self, loss: Tensor) -> None:
"""Run backward on the given loss, and step the optimizer.
- Requires an optimizer property."""
+ Requires an optimizer property.
+ """
self.optimizer.zero_grad()
loss.backward()
self.optimizer.step()
diff --git a/deeprecsys/neural_networks/deep_q_network.py b/deeprecsys/neural_networks/deep_q_network.py
index a84154a..fc0b6e2 100644
--- a/deeprecsys/neural_networks/deep_q_network.py
+++ b/deeprecsys/neural_networks/deep_q_network.py
@@ -21,7 +21,8 @@ def sequential_architecture(layers: List[int], bias: bool = True) -> Module:
class DeepQNetwork(BaseNetwork):
"""Implementation of a Deep Q Network with a Sequential arquitecture. Layers are
- supposed to be provided as a list of torch modules."""
+ supposed to be provided as a list of torch modules.
+ """
def __init__(
self,
@@ -66,16 +67,12 @@ def _calculate_loss(self, experiences: List[Tuple]) -> Tensor:
state_tensors = FloatTensor(states).to(device=self.device)
next_state_tensors = FloatTensor(next_states).to(device=self.device)
reward_tensors = FloatTensor(rewards).to(device=self.device).reshape(-1, 1)
- action_tensors = (
- LongTensor(array(actions)).reshape(-1, 1).to(device=self.device)
- )
+ action_tensors = LongTensor(array(actions)).reshape(-1, 1).to(device=self.device)
done_tensors = BoolTensor(dones).to(device=self.device)
actions_for_states = self.model(state_tensors)
q_vals = gather(actions_for_states, 1, action_tensors)
next_actions = [self.best_action_for_state(s) for s in next_states]
- next_action_tensors = (
- LongTensor(next_actions).reshape(-1, 1).to(device=self.device)
- )
+ next_action_tensors = LongTensor(next_actions).reshape(-1, 1).to(device=self.device)
q_vals_next = gather(self.model(next_state_tensors), 1, next_action_tensors)
q_vals_next[done_tensors] = 0
expected_q_vals = self.discount_factor * q_vals_next + reward_tensors
diff --git a/deeprecsys/neural_networks/dueling.py b/deeprecsys/neural_networks/dueling.py
index 373b56f..b5bf235 100644
--- a/deeprecsys/neural_networks/dueling.py
+++ b/deeprecsys/neural_networks/dueling.py
@@ -35,11 +35,10 @@ def __init__(
self.optimizer = Adam(self.parameters(), lr=learning_rate)
self.statistics = statistics
- def _build_network(
- self, n_input: int, n_output: int, noise_sigma: float, hidden_layers: List[int]
- ) -> None:
+ def _build_network(self, n_input: int, n_output: int, noise_sigma: float, hidden_layers: List[int]) -> None:
"""Build the dueling network with noisy layers, the value
- subnet and the advantage subnet. TODO: add `.to_device()` to Modules"""
+ subnet and the advantage subnet. TODO: add `.to_device()` to Modules
+ """
if len(hidden_layers) != 4:
raise ValueError("Unexpected amount of layers")
fc_1, fc_2, value_size, advantage_size = hidden_layers
@@ -65,9 +64,7 @@ def forward(self, state: Tensor) -> Tensor:
# This is the Dueling DQN part
# Combines V and A to get Q: Q(s,a) = V(s) + (A(s,a) - 1/|A| * sum A(s,a'))
if len(state.shape) == 2:
- q_values = value_of_state + (
- advantage_of_state - advantage_of_state.mean(dim=1, keepdim=True)
- )
+ q_values = value_of_state + (advantage_of_state - advantage_of_state.mean(dim=1, keepdim=True))
else:
q_values = value_of_state + (advantage_of_state - advantage_of_state.mean())
return q_values
@@ -85,69 +82,51 @@ def top_k_actions_for_state(self, state: Any, k: int = 1) -> List[int]:
_, top_indices = q_values.topk(k=k)
return [int(v) for v in top_indices.detach().numpy()] # TODO: cpu() ?
- def learn_with(
- self, buffer: PrioritizedExperienceReplayBuffer, target_network: Module
- ) -> None:
+ def learn_with(self, buffer: PrioritizedExperienceReplayBuffer, target_network: Module) -> None:
"""Train the target network using the replay buffer."""
experiences = buffer.sample_batch()
self.optimizer.zero_grad()
- td_error, weights = self._calculate_td_error_and_weigths(
- experiences, target_network
- )
+ td_error, weights = self._calculate_td_error_and_weigths(experiences, target_network)
loss = (td_error.pow(2) * weights).mean().to(self.device)
loss.backward()
self.optimizer.step()
# store loss in statistics
if self.statistics:
if self.device == "cuda":
- self.statistics.append_metric(
- "loss", float(loss.detach().cpu().numpy())
- )
+ self.statistics.append_metric("loss", float(loss.detach().cpu().numpy()))
else:
self.statistics.append_metric("loss", float(loss.detach().numpy()))
# update buffer priorities
- errors_from_batch = td_error.detach().cpu().numpy()
+ errors_from_batch = td_error.detach().cpu().numpy().flatten()
buffer.update_priorities(experiences, errors_from_batch)
def _calculate_td_error_and_weigths(
self, experiences: List[Tuple], target_network: Module
) -> Tuple[Tensor, Tensor]:
- states, actions, rewards, dones, next_states, weights, samples = [
- i for i in experiences
- ]
+ states, actions, rewards, dones, next_states, weights, samples = [i for i in experiences]
# convert to tensors
state_tensors = FloatTensor(states).to(device=self.device)
next_state_tensors = FloatTensor(next_states).to(device=self.device)
reward_tensors = FloatTensor(rewards).to(device=self.device).reshape(-1, 1)
- action_tensors = (
- LongTensor(array(actions)).reshape(-1, 1).to(device=self.device)
- )
+ action_tensors = LongTensor(array(actions)).reshape(-1, 1).to(device=self.device)
done_tensors = BoolTensor(dones).to(device=self.device)
weight_tensors = FloatTensor(weights).to(device=self.device)
# the following logic is the DDQN update
# Then we get the predicted actions for the states that came next
# (using the main network)
- actions_for_next_states = [
- self.top_k_actions_for_state(s)[0] for s in next_state_tensors
- ]
- actions_for_next_states_tensor = (
- LongTensor(actions_for_next_states).reshape(-1, 1).to(device=self.device)
- )
+ actions_for_next_states = [self.top_k_actions_for_state(s)[0] for s in next_state_tensors]
+ actions_for_next_states_tensor = LongTensor(actions_for_next_states).reshape(-1, 1).to(device=self.device)
# Then we use them to get the estimated Q Values for these next states/actions,
# according to the target network. Remember that the target network is a copy
# of this one taken some steps ago
next_q_values = target_network.forward(next_state_tensors)
# now we get the q values for the actions that were predicted for the next state
# we call detach() so no gradient will be backpropagated along this variable
- next_q_values_for_actions = gather(
- next_q_values, 1, actions_for_next_states_tensor
- ).detach()
+ next_q_values_for_actions = gather(next_q_values, 1, actions_for_next_states_tensor).detach()
# zero value for done timesteps
next_q_values_for_actions[done_tensors] = 0
# bellman equation
- expected_q_values = (
- self.discount_factor * next_q_values_for_actions + reward_tensors
- )
+ expected_q_values = self.discount_factor * next_q_values_for_actions + reward_tensors
# Then get the Q-Values of the main network for the selected actions
q_values = gather(self.forward(state_tensors), 1, action_tensors)
# And compare them (this is the time-difference or TD error)
diff --git a/deeprecsys/neural_networks/noisy_layer.py b/deeprecsys/neural_networks/noisy_layer.py
index 12cb559..cf27d98 100644
--- a/deeprecsys/neural_networks/noisy_layer.py
+++ b/deeprecsys/neural_networks/noisy_layer.py
@@ -5,7 +5,8 @@
class NoisyLayer(Linear):
"""Special type of layer that adds random gaussian noise to the signal The gaussian noise parameters are
- registered, and therefore the noise decreases over time. This is a better alternative to e-greedy exploration."""
+ registered, and therefore the noise decreases over time. This is a better alternative to e-greedy exploration.
+ """
def __init__(
self,
@@ -15,7 +16,8 @@ def __init__(
sigma: float = 0.017,
) -> None:
"""Create the layer with the given sigma weight. Registers epsilon as a parameter so that the network will
- learn to reduce the noise."""
+ learn to reduce the noise.
+ """
super().__init__(in_features, out_features, bias=bias)
self.sigma_weight = Parameter(torch.full((out_features, in_features), sigma))
self.register_buffer("epsilon_weight", torch.zeros(out_features, in_features))
@@ -27,12 +29,11 @@ def forward(self, input: Tensor) -> Tensor:
"""At every forward operation, feeds the weights and biases with normally
distributed random variables with mean zero and std deviation 1. This means
the bias and the weights will have a noise of:
- sigma (constant) * epsilon (random in range(-1,1))"""
+ sigma (constant) * epsilon (random in range(-1,1))
+ """
self.epsilon_weight.normal_()
bias = self.bias
if bias is not None:
self.epsilon_bias.normal_()
bias = bias + self.sigma_bias * self.epsilon_bias.clone()
- return functional.linear(
- input, self.weight + self.sigma_weight * self.epsilon_weight.clone(), bias
- )
+ return functional.linear(input, self.weight + self.sigma_weight * self.epsilon_weight.clone(), bias)
diff --git a/deeprecsys/neural_networks/policy_estimator.py b/deeprecsys/neural_networks/policy_estimator.py
index 3d0feb0..414e822 100644
--- a/deeprecsys/neural_networks/policy_estimator.py
+++ b/deeprecsys/neural_networks/policy_estimator.py
@@ -12,7 +12,8 @@
class PolicyEstimator(BaseNetwork):
"""Estimates the policy function: the probability of each action being the
- best decision in a particular state."""
+ best decision in a particular state.
+ """
def __init__(
self,
@@ -37,12 +38,14 @@ def __init__(
def action_probabilities(self, state: Any) -> Tensor:
"""Return a map of each possible action, and the probability that that's the best action to take at
- this step."""
+ this step.
+ """
return self.model(FloatTensor(state))
def predict(self, state: Any, k: int = 1) -> List[int]:
"""Given a state, uses the network output to choose the `k` best next actions according to the probability
- distribution trained so far."""
+ distribution trained so far.
+ """
probabilities = self.action_probabilities(state)
prediction = multinomial(probabilities, num_samples=k, replacement=False)
if self.device == "cuda":
@@ -50,14 +53,10 @@ def predict(self, state: Any, k: int = 1) -> List[int]:
else:
return prediction.detach().numpy()
- def update(
- self, state: np.array, reward_baseline: Tensor, action: np.array
- ) -> np.ndarray:
+ def update(self, state: np.array, reward_baseline: Tensor, action: np.array) -> np.ndarray:
"""Update the network with the given state, reward, and action taken."""
state_tensor = FloatTensor(state).to(device=self.device)
- action_tensor = FloatTensor(np.array(action, dtype=np.float32)).to(
- device=self.device
- )
+ action_tensor = FloatTensor(np.array(action, dtype=np.float32)).to(device=self.device)
""" Update logic from the Policy Gradient theorem. """
action_probabilities = self.model(state_tensor)
action_distribution = Categorical(action_probabilities)
diff --git a/deeprecsys/neural_networks/q_value_estimator.py b/deeprecsys/neural_networks/q_value_estimator.py
index ad95a29..b4995ea 100644
--- a/deeprecsys/neural_networks/q_value_estimator.py
+++ b/deeprecsys/neural_networks/q_value_estimator.py
@@ -23,16 +23,15 @@ def __init__(self, inputs: int, outputs: int, learning_rate: float = 1e-3):
def predict(self, states: Tensor, actions: Tensor) -> Tensor:
"""Given a state and an action, return the estimated Q-Value"""
- inputs = torch.cat([states, actions.type(FloatTensor)], dim=1).to(
- device=self.device
- )
+ inputs = torch.cat([states, actions.type(FloatTensor)], dim=1).to(device=self.device)
return self.model(inputs)
class TwinnedQValueEstimator(BaseNetwork):
"""Estimate the Q-value (expected return) of each (state,action) pair,
using 2 independent estimators, and predicting with the minimum estimated Q-value.
- This is the "critic" part of the Actor-Critic model."""
+ This is the "critic" part of the Actor-Critic model.
+ """
def __init__(self, inputs: int, outputs: int = 1, learning_rate: float = 1e-3):
"""Create the two estimators with the provided parameters."""
diff --git a/deeprecsys/neural_networks/value_estimator.py b/deeprecsys/neural_networks/value_estimator.py
index f82d250..95f3261 100644
--- a/deeprecsys/neural_networks/value_estimator.py
+++ b/deeprecsys/neural_networks/value_estimator.py
@@ -11,7 +11,8 @@
class ValueEstimator(BaseNetwork):
"""Estimates the value function: the expected return of being in a
- particular state"""
+ particular state
+ """
def __init__(
self,
@@ -22,9 +23,7 @@ def __init__(
):
"""Create the network with the given parameters. The output should always be one."""
super().__init__()
- self.model = sequential_architecture(
- [input_size] + hidden_layers + [output_size]
- )
+ self.model = sequential_architecture([input_size] + hidden_layers + [output_size])
self.optimizer = Adam(self.parameters(), lr=learning_rate)
if self.device == "cuda":
self.model.cuda()
diff --git a/deeprecsys/rl/agents/actor_critic.py b/deeprecsys/rl/agents/actor_critic.py
index c21a7cf..89f7261 100644
--- a/deeprecsys/rl/agents/actor_critic.py
+++ b/deeprecsys/rl/agents/actor_critic.py
@@ -13,7 +13,8 @@ class ActorCriticAgent(ReinforcementLearning):
"""Policy estimator using a value estimator as a baseline.
It's on-policy, for discrete action spaces, and episodic environments.
This implementation uses stochastic policies.
- TODO: could be a sub class of reinforce"""
+ TODO: could be a sub class of reinforce
+ """
buffer: ExperienceReplayBuffer
@@ -51,9 +52,7 @@ def __init__(
def reset_buffer(self) -> None:
"""Clear all the experiences from the buffer"""
- self.buffer = ExperienceReplayBuffer(
- ExperienceReplayBufferParameters(10000, 1, 1)
- )
+ self.buffer = ExperienceReplayBuffer(ExperienceReplayBufferParameters(10000, 1, 1))
def top_k_actions_for_state(self, state: Any, k: int = 1) -> List[int]:
"""Return the next best K action"""
@@ -63,9 +62,7 @@ def action_for_state(self, state: Any) -> int:
"""Return the next best action"""
return self.top_k_actions_for_state(state)[0]
- def store_experience(
- self, state: Any, action: Any, reward: float, done: bool, new_state: Any
- ) -> None:
+ def store_experience(self, state: Any, action: Any, reward: float, done: bool, new_state: Any) -> None:
"""Store the experience in the experience buffer"""
state_flat = state.flatten()
new_state_flat = new_state.flatten()
@@ -81,7 +78,7 @@ def learn_from_experiences(self) -> None:
for timestep, experience in enumerate(experiences):
total_return = 0
for i, t in enumerate(experiences[timestep:]):
- total_return += (self.discount_factor ** i) * t.reward
+ total_return += (self.discount_factor**i) * t.reward
# Calculate baseline/advantage
baseline_value = self.value_estimator.predict(experience.state).detach()
diff --git a/deeprecsys/rl/agents/agent.py b/deeprecsys/rl/agents/agent.py
index 02b471d..96a2d9b 100644
--- a/deeprecsys/rl/agents/agent.py
+++ b/deeprecsys/rl/agents/agent.py
@@ -1,7 +1,7 @@
from abc import ABC, abstractmethod
from typing import Any
-from gym import Space
+from gymnasium import Space
class ReinforcementLearning(ABC):
@@ -16,15 +16,14 @@ def top_k_actions_for_state(self, state: Any, k: int = 1) -> Any:
"""Retrieve the next K best actions for this state."""
@abstractmethod
- def store_experience(
- self, state: Any, action: Any, reward: float, done: bool, new_state: Any
- ) -> None:
+ def store_experience(self, state: Any, action: Any, reward: float, done: bool, new_state: Any) -> None:
"""Store an experience (used in case of experience replay buffers)"""
class RandomAgent(ReinforcementLearning):
"""An agent that randomly samples actions, regardless of the
- environment's state."""
+ environment's state.
+ """
action_space: Space
@@ -42,8 +41,6 @@ def top_k_actions_for_state(self, state: Any, k: int = 1) -> Any:
"""Randomly sample K actions from the action space."""
return self.action_space.sample()
- def store_experience(
- self, state: Any, action: Any, reward: float, done: bool, new_state: Any
- ) -> None:
+ def store_experience(self, state: Any, action: Any, reward: float, done: bool, new_state: Any) -> None:
"""Ignore the experience because this agent doesn't have any experience replay."""
pass
diff --git a/deeprecsys/rl/agents/dqn.py b/deeprecsys/rl/agents/dqn.py
index b78fbf6..c2055de 100644
--- a/deeprecsys/rl/agents/dqn.py
+++ b/deeprecsys/rl/agents/dqn.py
@@ -43,9 +43,7 @@ def __init__(
random_state,
)
- architecture = sequential_architecture(
- [input_size] + hidden_layers + [output_size]
- )
+ architecture = sequential_architecture([input_size] + hidden_layers + [output_size])
self.network = DeepQNetwork(learning_rate, architecture, discount_factor)
self.buffer = ExperienceReplayBuffer(
ExperienceReplayBufferParameters(
@@ -88,9 +86,7 @@ def exploit(self, state: Any) -> float:
"""TODO"""
return self.network.best_action_for_state(state)
- def store_experience(
- self, state: Any, action: Any, reward: float, done: bool, new_state: Any
- ) -> None:
+ def store_experience(self, state: Any, action: Any, reward: float, done: bool, new_state: Any) -> None:
"""TODO"""
if done and self.buffer.ready_to_predict():
self._decay()
diff --git a/deeprecsys/rl/agents/epsilon_greedy.py b/deeprecsys/rl/agents/epsilon_greedy.py
index 266c7c1..4889991 100644
--- a/deeprecsys/rl/agents/epsilon_greedy.py
+++ b/deeprecsys/rl/agents/epsilon_greedy.py
@@ -26,7 +26,8 @@ def __init__(
def action_for_state(self, state: Any) -> Any:
"""With probability epsilon, we explore by sampling one of the random available actions.
- Otherwise we exploit by chosing the action with the highest Q value."""
+ Otherwise we exploit by chosing the action with the highest Q value.
+ """
if self.random_state.random() < self.epsilon:
action = self.explore()
else:
@@ -35,9 +36,7 @@ def action_for_state(self, state: Any) -> Any:
def _decay(self) -> None:
"""Slowly decrease the exploration probability."""
- self.epsilon = max(
- self.epsilon * self.decay_rate, self.minimum_exploration_probability
- )
+ self.epsilon = max(self.epsilon * self.decay_rate, self.minimum_exploration_probability)
@abstractmethod
def explore(self) -> Any:
diff --git a/deeprecsys/rl/agents/rainbow.py b/deeprecsys/rl/agents/rainbow.py
index 4b7ba43..786d1d0 100644
--- a/deeprecsys/rl/agents/rainbow.py
+++ b/deeprecsys/rl/agents/rainbow.py
@@ -20,7 +20,8 @@ class RainbowDQNAgent(ReinforcementLearning):
"""Instead of sampling randomly from the buffer we prioritize experiences with PER
Instead of epsilon-greedy we use gaussian noisy layers for exploration
Instead of the Q value we calculate Value and Advantage (Dueling DQN).
- This implementation does not include the Categorical DQN part (yet)."""
+ This implementation does not include the Categorical DQN part (yet).
+ """
def __init__(
self,
@@ -98,9 +99,7 @@ def action_for_state(self, state: Any) -> Any:
"""Get the next best action for the given state."""
return self.top_k_actions_for_state(state, k=1)[0]
- def store_experience(
- self, state: Any, action: Any, reward: float, done: bool, new_state: Any
- ) -> None:
+ def store_experience(self, state: Any, action: Any, reward: float, done: bool, new_state: Any) -> None:
"""Store the experience in the buffer"""
state_flat = state.flatten()
new_state_flat = new_state.flatten()
diff --git a/deeprecsys/rl/agents/reinforce.py b/deeprecsys/rl/agents/reinforce.py
index 27d3512..ba76619 100644
--- a/deeprecsys/rl/agents/reinforce.py
+++ b/deeprecsys/rl/agents/reinforce.py
@@ -13,7 +13,8 @@
class ReinforceAgent(ReinforcementLearning):
"""REINFORCE: Policy estimator using a value estimator as a baseline.
- It's on-policy, for discrete action spaces, and episodic environments."""
+ It's on-policy, for discrete action spaces, and episodic environments.
+ """
buffer: ExperienceReplayBuffer
@@ -26,7 +27,8 @@ def __init__(
learning_rate: float = 1e-3,
):
"""Start the network with the parameters provided.
- The discount factor is commonly known as gamma."""
+ The discount factor is commonly known as gamma.
+ """
self.episode_count = 0
if not hidden_layers:
hidden_layers = [state_size * 2, state_size * 2]
@@ -42,10 +44,9 @@ def __init__(
def reset_buffer(self) -> None:
"""Recreate the experience buffer, effectively forgetting all the experiences
- collected so far."""
- self.buffer = ExperienceReplayBuffer(
- ExperienceReplayBufferParameters(10000, 1, 1)
- )
+ collected so far.
+ """
+ self.buffer = ExperienceReplayBuffer(ExperienceReplayBufferParameters(10000, 1, 1))
def top_k_actions_for_state(self, state: Any, k: int = 1) -> List[int]:
"""Return the k next best actions for the given state."""
@@ -55,9 +56,7 @@ def action_for_state(self, state: Any) -> int:
"""Return the best action for the given state."""
return self.top_k_actions_for_state(state)[0]
- def store_experience(
- self, state: Any, action: Any, reward: float, done: bool, new_state: Any
- ) -> None:
+ def store_experience(self, state: Any, action: Any, reward: float, done: bool, new_state: Any) -> None:
"""Store the experience in the buffer and run the backpropagation if the buffer is ready."""
state_flat = state.flatten()
new_state_flat = new_state.flatten()
@@ -70,7 +69,8 @@ def store_experience(
def discounted_rewards(self, rewards: np.array) -> np.array:
"""From a list of rewards obtained in an episode, we calculate
the return minus the baseline. The baseline is the list of discounted
- rewards minus the mean, divided by the standard deviation."""
+ rewards minus the mean, divided by the standard deviation.
+ """
discount_r = np.zeros_like(rewards)
timesteps = range(len(rewards))
reward_sum = 0
@@ -85,9 +85,7 @@ def discounted_rewards(self, rewards: np.array) -> np.array:
def learn_from_experiences(self) -> None:
"""Train the policy estimator with all the experiences collected so far."""
experiences = list(self.buffer.experience_queue)
- states, actions, rewards, dones, next_states = zip(*experiences)
+ states, actions, rewards, dones, next_states = zip(*experiences, strict=False)
advantages = self.discounted_rewards(rewards)
- advantages_tensor = FloatTensor(advantages).to(
- device=self.policy_estimator.device
- )
+ advantages_tensor = FloatTensor(advantages).to(device=self.policy_estimator.device)
self.policy_estimator.update(states, advantages_tensor, actions)
diff --git a/deeprecsys/rl/agents/soft_actor_critic.py b/deeprecsys/rl/agents/soft_actor_critic.py
index 491c69b..e49dba5 100644
--- a/deeprecsys/rl/agents/soft_actor_critic.py
+++ b/deeprecsys/rl/agents/soft_actor_critic.py
@@ -2,7 +2,7 @@
from typing import Any, Optional
import torch
-from gym.spaces import Discrete
+from gymnasium.spaces import Discrete
from torch import BoolTensor, FloatTensor
from deeprecsys.neural_networks.gaussian_actor import GaussianActor
@@ -21,7 +21,8 @@ class SoftActorCritic(ReinforcementLearning):
"""TODO: there's things to fix in this agent. It needs temperature
optimization, and replace the current q-value estimator with the
Q-value + value + value_target estimators, like described here
- https://lilianweng.github.io/lil-log/2018/04/08/policy-gradient-algorithms.html"""
+ https://lilianweng.github.io/lil-log/2018/04/08/policy-gradient-algorithms.html
+ """
def __init__(
self,
@@ -50,9 +51,7 @@ def __init__(
entropy_coefficient=entropy_coefficient,
discount_factor=discount_factor,
)
- self.critic = TwinnedQValueEstimator(
- inputs=state_size + 1, learning_rate=learning_rate
- )
+ self.critic = TwinnedQValueEstimator(inputs=state_size + 1, learning_rate=learning_rate)
self.target_critic = deepcopy(self.critic)
self.buffer = PrioritizedExperienceReplayBuffer(
buffer_parameters=buffer_parameters,
@@ -72,8 +71,7 @@ def __init__(
def should_update_network(self) -> bool:
"""Check if the buffer is ready to predict and if enough timesteps have passed."""
return (
- self.timesteps >= self.timesteps_to_start_predicting
- and self.buffer.ready_to_predict() # noqa
+ self.timesteps >= self.timesteps_to_start_predicting and self.buffer.ready_to_predict() # noqa
)
def action_for_state(self, state: Any) -> Any:
@@ -88,9 +86,7 @@ def top_k_actions_for_state(self, state: Any, k: int = 1) -> Any:
"""TODO"""
pass
- def store_experience(
- self, state: Any, action: Any, reward: float, done: bool, new_state: Any
- ) -> None:
+ def store_experience(self, state: Any, action: Any, reward: float, done: bool, new_state: Any) -> None:
"""Store the experience in the buffer."""
self.timesteps += 1
state_flat = state.flatten()
@@ -127,9 +123,7 @@ def learn(self) -> None:
# batch with indices and priority weights
batch = self.buffer.sample_batch()
- states, actions, rewards, dones, next_states, weights, samples = [
- i for i in batch
- ]
+ states, actions, rewards, dones, next_states, weights, samples = [i for i in batch]
# convert to tensors
device = self.critic.device
state_tensors = FloatTensor(states).to(device=device)
diff --git a/deeprecsys/rl/experience_replay/buffer_parameters.py b/deeprecsys/rl/experience_replay/buffer_parameters.py
index 4e52914..af1819c 100644
--- a/deeprecsys/rl/experience_replay/buffer_parameters.py
+++ b/deeprecsys/rl/experience_replay/buffer_parameters.py
@@ -17,16 +17,15 @@ def __init__(
if minimum_experiences_to_start_predicting < batch_size:
raise ValueError("The batch size mus the larger than the burn in")
self.max_experiences = max_experiences
- self.minimum_experiences_to_start_predicting = (
- minimum_experiences_to_start_predicting
- )
+ self.minimum_experiences_to_start_predicting = minimum_experiences_to_start_predicting
self.batch_size = batch_size
self.random_state = random_state
class PERBufferParameters:
"""Parameters to configure the prioritization of experiences in a
- Prioritized-Experience Replay Buffer"""
+ Prioritized-Experience Replay Buffer
+ """
def __init__(
self,
diff --git a/deeprecsys/rl/experience_replay/experience_buffer.py b/deeprecsys/rl/experience_replay/experience_buffer.py
index ae4592c..b3a2c75 100644
--- a/deeprecsys/rl/experience_replay/experience_buffer.py
+++ b/deeprecsys/rl/experience_replay/experience_buffer.py
@@ -16,22 +16,21 @@ class ExperienceBuffer(ABC):
@abstractmethod
def ready_to_predict(self) -> bool:
- """Whether or not enough experiences were collected"""
+ """Whether enough experiences were collected"""
@abstractmethod
def sample_batch(self) -> List[Tuple]:
"""Sample a batch of experiences from the buffer."""
@abstractmethod
- def store_experience(
- self, state: Any, action: Any, reward: float, done: bool, next_state: Any
- ) -> None:
+ def store_experience(self, state: Any, action: Any, reward: float, done: bool, next_state: Any) -> None:
"""Store an experience in the buffer."""
class ExperienceReplayBuffer(ExperienceBuffer):
"""Traditional experience replay buffer. Experiences are sampled randomly without
- replacements within batches. Different batches may contain the same experience."""
+ replacements within batches. Different batches may contain the same experience.
+ """
def __init__(
self,
@@ -40,9 +39,7 @@ def __init__(
"""Initialize the buffer with the provided parameters."""
if not parameters:
parameters = ExperienceReplayBufferParameters()
- self.minimum_experiences_to_start_predicting = (
- parameters.minimum_experiences_to_start_predicting
- )
+ self.minimum_experiences_to_start_predicting = parameters.minimum_experiences_to_start_predicting
self.random_state = parameters.random_state
# create double ended queue to store the experiences
self.experience_queue: List = list(deque(maxlen=parameters.max_experiences))
@@ -51,17 +48,13 @@ def __init__(
def sample_batch(self) -> List[Tuple]:
"""Sample a given number of experiences from the queue"""
# samples the index of `batch_size` different experiences from the replay memory
- samples = self.random_state.choice(
- len(self.experience_queue), self.batch_size, replace=False
- )
+ samples = self.random_state.choice(len(self.experience_queue), self.batch_size, replace=False)
# get the experiences
experiences = [self.experience_queue[i] for i in samples]
# returns a flattened list of the samples
- return zip(*experiences) # type: ignore
+ return zip(*experiences, strict=False) # type: ignore
- def store_experience(
- self, state: Any, action: Any, reward: float, done: bool, next_state: Any
- ) -> None:
+ def store_experience(self, state: Any, action: Any, reward: float, done: bool, next_state: Any) -> None:
"""Store a new experience in the queue"""
experience = Experience(state, action, reward, done, next_state) # type: ignore
# append to the right (end) of the queue
@@ -69,7 +62,6 @@ def store_experience(
def ready_to_predict(self) -> bool:
"""Return true only if we had enough experiences to start predicting
- (measured by the burn in)"""
- return (
- len(self.experience_queue) >= self.minimum_experiences_to_start_predicting
- )
+ (measured by the burn in)
+ """
+ return len(self.experience_queue) >= self.minimum_experiences_to_start_predicting
diff --git a/deeprecsys/rl/experience_replay/priority_replay_buffer.py b/deeprecsys/rl/experience_replay/priority_replay_buffer.py
index 7ead20f..cbc6da6 100644
--- a/deeprecsys/rl/experience_replay/priority_replay_buffer.py
+++ b/deeprecsys/rl/experience_replay/priority_replay_buffer.py
@@ -20,7 +20,8 @@
class PrioritizedExperienceReplayBuffer(ExperienceReplayBuffer):
"""Experience Replay Buffer that gives priority to experiences that the network learns more from. We can tell this
- using the loss. We use importance sampling to avoid bias towards those experiences."""
+ using the loss. We use importance sampling to avoid bias towards those experiences.
+ """
def __init__(
self,
@@ -45,15 +46,12 @@ def __init__(
def priorities(self) -> numpy.array:
"""Get the priority of each experience in the queue"""
- return numpy.array(
- [e.priority for e in self.experience_queue], dtype=numpy.float32
- )
+ return numpy.array([e.priority for e in self.experience_queue], dtype=numpy.float32)
- def store_experience(
- self, state: Any, action: Any, reward: float, done: bool, next_state: Any
- ) -> None:
+ def store_experience(self, state: Any, action: Any, reward: float, done: bool, next_state: Any) -> None:
"""We include a priority to the experience. if the queue is empty, priority is 1 (max),
- otherwise we check the maximum priority in the queue"""
+ otherwise we check the maximum priority in the queue
+ """
priorities = self.priorities()
priority = priorities.max() if len(priorities) > 0 else 1.0
if not np.isnan(priority):
@@ -64,41 +62,40 @@ def store_experience(
def update_beta(self) -> None:
"""We want to grow the beta value slowly and linearly, starting at a value
- close to zero, and stopping at 1.0. This is for the Importance Sampling"""
+ close to zero, and stopping at 1.0. This is for the Importance Sampling
+ """
if self.beta < 1.0:
self.beta += self.beta_growth
- def update_priorities(
- self, batch: List[Tuple], errors_from_batch: List[float]
- ) -> None:
+ def update_priorities(self, batch: List[Tuple], errors_from_batch: List[float]) -> None:
"""We want the priority of elements to be the TD error of plus an epsilon
constant. The epsilon constant makes sure that no experience ever gets a
priority zero. This prioritization strategy gives more importance to
- elements that bring more learning to the network."""
- experience_indexes = [b[-1] for b in numpy.array(batch, dtype=numpy.object).T]
+ elements that bring more learning to the network.
+ """
+ experience_indexes = [b[-1] for b in numpy.array(batch, dtype="object").T]
for i in range(len(experience_indexes)):
error = abs(errors_from_batch[i]) + self.epsilon
if not np.isnan(error):
- self.experience_queue[experience_indexes[i]] = self.experience_queue[
- experience_indexes[i]
- ]._replace(priority=error)
+ experience = self.experience_queue[experience_indexes[i]]
+ experience._replace(priority=error)
+ self.experience_queue[experience_indexes[i]] = experience
def sample_batch(self) -> List[Tuple]:
"""We sample experiences using their priorities as weights for sampling. The
effect of the priorities is controlled by the alpha parameter. This is
- already an advantage but it can introduce bias in a network by always
+ already an advantage, but it can introduce bias in a network by always
choosing the same type of experiences for training. In order to fight this, we
compute the weight of the experience (this is called Importance Sampling,
or IP). We want the weights to decrease over time, this is controlled by
- the beta parameter."""
+ the beta parameter.
+ """
# calculate probabilities (alpha)
probabilities = self.priorities() ** self.alpha
p = probabilities / probabilities.sum()
# sample experiences
buffer_size = len(self.experience_queue)
- samples = numpy.random.choice(
- a=buffer_size, size=self.batch_size, p=p, replace=False
- )
+ samples = numpy.random.choice(a=buffer_size, size=self.batch_size, p=p, replace=False)
experiences = [self.experience_queue[i].experience for i in samples]
# importance Sampling
# w_i = (1/N * 1/P_i) ^ beta
@@ -106,4 +103,4 @@ def sample_batch(self) -> List[Tuple]:
weights = weights / weights.max()
self.update_beta()
# return experiences with weights
- return list(zip(*experiences)) + [tuple(weights)] + [tuple(samples)]
+ return list(zip(*experiences, strict=False)) + [tuple(weights)] + [tuple(samples)]
diff --git a/deeprecsys/rl/learning_statistics.py b/deeprecsys/rl/learning_statistics.py
index d6422a1..c312831 100644
--- a/deeprecsys/rl/learning_statistics.py
+++ b/deeprecsys/rl/learning_statistics.py
@@ -11,9 +11,7 @@
class LearningStatistics:
"""Special class to store and aggregate learning parameters."""
- def __init__(
- self, model_name: Optional[str] = None, env_name: Optional[str] = None
- ):
+ def __init__(self, model_name: Optional[str] = None, env_name: Optional[str] = None):
"""Start the collector for the given model and environment name."""
self.collected_metrics: List[Dict] = []
self.model_name = model_name
diff --git a/deeprecsys/rl/manager.py b/deeprecsys/rl/manager.py
index eaa6b83..b0a7634 100644
--- a/deeprecsys/rl/manager.py
+++ b/deeprecsys/rl/manager.py
@@ -2,14 +2,12 @@
from collections import defaultdict, namedtuple
from typing import Any, Generator, List, Optional
-import highway_env # noqa: F401
import numpy as np
import torch
-from gym import Env, make, spec
+from gymnasium import Env, make, spec
from numpy.core.multiarray import ndarray
from numpy.random import RandomState
-import deeprecsys.movielens_fairness_env # noqa: F401
from deeprecsys.rl import Logger
from deeprecsys.rl.agents.agent import ReinforcementLearning
from deeprecsys.rl.learning_statistics import LearningStatistics
@@ -22,11 +20,13 @@
logger = Logger.create()
-class Manager(object):
+class Manager:
"""Class for learning from gym environments with some convenience methods."""
env_name: str
env: Any
+ seed: int | None = None
+ random_state: RandomState | None = None
def __init__(
self,
@@ -38,19 +38,13 @@ def __init__(
**kwargs: Any,
) -> None:
"""Start the manager"""
- if any(
- [env_name is None and env is None, env_name is not None and env is not None]
- ):
+ if any([env_name is None and env is None, env_name is not None and env is not None]):
raise ValueError("Must specify exactly one of [env_name, env]")
if env_name is not None:
self.env_name = env_name
# extract some parameters from the environment
- self.max_episode_steps = (
- spec(self.env_name).max_episode_steps or max_episode_steps
- )
- self.reward_threshold = (
- spec(self.env_name).reward_threshold or reward_threshold
- )
+ self.max_episode_steps = spec(self.env_name).max_episode_steps or max_episode_steps
+ self.reward_threshold = spec(self.env_name).reward_threshold or reward_threshold
# create the environment
self.env = make(env_name, **kwargs)
# we seed the environment so that results are reproducible
@@ -77,10 +71,11 @@ def execute_episodes(
should_render: bool = False,
) -> List[EpisodeOutput]:
"""Execute any number of episodes with the given agent.
- Returns the number of timesteps and sum of rewards per episode."""
+ Returns the number of timesteps and sum of rewards per episode.
+ """
episode_outputs = []
for episode in range(n_episodes):
- t, reward_sum, done, state = 0, 0, False, self.env.reset()
+ t, reward_sum, done, (state, _) = 0, 0, False, self.env.reset(seed=self.seed)
logger.info(f"Running episode {episode}, starting at state {state}")
while not done and t < self.max_episode_steps:
if should_render:
@@ -106,9 +101,7 @@ def _train_update_timestep(statistics: LearningStatistics) -> None:
statistics.timestep += 1
@staticmethod
- def _train_add_statistics(
- statistics: LearningStatistics, rewards: List, moving_average: ndarray
- ) -> None:
+ def _train_add_statistics(statistics: LearningStatistics, rewards: List, moving_average: ndarray) -> None:
if statistics:
statistics.append_metric("episode_rewards", sum(rewards))
statistics.append_metric("timestep_rewards", rewards)
@@ -130,13 +123,13 @@ def train(
logger.info("Training...")
episode_rewards = []
for episode in range(max_episodes):
- state = self.env.reset()
+ state, info = self.env.reset(seed=self.seed)
rewards = []
self._train_start_new_episode(statistics, episode)
done = False
while done is False:
action = self._train_get_step_action(rl, state)
- new_state, reward, done, info = self.env.step(action)
+ new_state, reward, done, _, info = self.env.step(action)
if "chosen_action" in info:
action = action[info["chosen_action"]]
rl.store_experience(state, action, reward, done, new_state)
@@ -189,7 +182,7 @@ def hyperparameter_search(
for the given number of episodes, and will run the determined number of times.
"""
combination_results = defaultdict(lambda: [])
- for (p_name, p_value) in params.items():
+ for p_name, p_value in params.items():
if len(p_value) < 2:
continue
for value in p_value:
@@ -208,9 +201,7 @@ def hyperparameter_search(
return combination_results
- def setup_reproducibility(
- self, seed: Optional[int] = None
- ) -> Optional[RandomState]:
+ def setup_reproducibility(self, seed: Optional[int] = None) -> Optional[RandomState]:
"""Seeds the project's libraries: numpy, torch, gym"""
if seed:
# seed pytorch
@@ -220,7 +211,7 @@ def setup_reproducibility(
# seed numpy
np.random.seed(seed)
# seed gym
- self.env.seed(seed)
+ self.seed = seed
self.random_state = RandomState(seed)
return self.random_state
return None
@@ -241,7 +232,7 @@ class CartpoleManager(Manager):
def __init__(self, seed: Optional[int] = None):
"""Start the manager"""
- super().__init__(env_name="CartPole-v0", seed=seed)
+ super().__init__(env_name="CartPole-v1", seed=seed)
self.reward_threshold = 50
@@ -258,6 +249,4 @@ class MovieLensFairnessManager(Manager):
def __init__(self, seed: Optional[int] = None, slate_size: int = 1):
"""Start the manager"""
- super().__init__(
- env_name="MovieLensFairness-v0", seed=seed, slate_size=slate_size
- )
+ super().__init__(env_name="MovieLensFairness-v0", seed=seed, slate_size=slate_size)
diff --git a/deeprecsys/visit_simulator/__init__.py b/deeprecsys/visit_simulator/__init__.py
deleted file mode 100644
index e69de29..0000000
diff --git a/deeprecsys/visit_simulator/simulator_env.py b/deeprecsys/visit_simulator/simulator_env.py
deleted file mode 100644
index b13117a..0000000
--- a/deeprecsys/visit_simulator/simulator_env.py
+++ /dev/null
@@ -1,105 +0,0 @@
-from typing import Any, List, Tuple
-
-import numpy
-import pandas
-from torch import FloatTensor
-from torch.utils.data import DataLoader, Dataset
-
-from deeprecsys.neural_networks.binary_classifier import BinaryClassifier
-
-
-class HomelikeDataset(Dataset):
- def __init__(self) -> None:
- base_path = "/home/farris/Developer/hl-ranking-algorithm/hl_ranking_algorithm/live_ranking/offline_training/"
- self.users = (
- pandas.read_feather(base_path + "users.feather")
- .set_index("session_id")
- .dropna()
- )
- self.history = pandas.read_feather(base_path + "history.feather")
- self.inventory = (
- pandas.read_feather(base_path + "inventory.feather")
- .set_index("pg_id")
- .astype("float64")
- )
- self.length = self.history.action.apply(len).sum()
- self.user_index = 0
- self.user_history: List[Any] = []
- self.user_features = None
- self.num_features = self.users.shape[1] + self.inventory.shape[1]
-
- def __getitem__(self, *_: Any) -> Tuple[FloatTensor, FloatTensor]:
- if len(self.user_history) == 0:
- self.user_features = self.users.iloc[self.user_index]
- self.user_index += 1
- user_history = self.history.query(
- f"session_id == '{self.users.index[0]}'"
- ).explode("action")
- user_history["reward"] = user_history.apply(
- lambda df: df.action in df.reward, axis="columns"
- )
- self.user_history = user_history[["action", "reward"]].values.tolist()
- action, reward = self.user_history.pop()
- item_features = self.inventory.loc[action].values
- return (
- FloatTensor(numpy.concatenate((item_features, self.user_features), axis=0)),
- FloatTensor([reward]),
- )
-
- def __len__(self) -> int:
- return self.length
-
-
-def generate_network_parameters(batch_size: int = 256) -> None:
- dataset = HomelikeDataset()
- data_loader = DataLoader(dataset, batch_size=batch_size, shuffle=False)
- classifier = BinaryClassifier(input_shape=dataset.num_features)
- for epoch in range(1):
- for ix, data in enumerate(data_loader, 0):
- features, targets = data
- loss = classifier.update(features, targets)
- print(
- f"Epoch {epoch + 1} Batch {ix}/{int(dataset.length/batch_size)} Loss {loss}"
- )
- classifier.save("visit_simulator.pch")
-
-
-if __name__ == "__main__":
- generate_network_parameters()
-
-
-# class HomelikeApartmentSearch(Env):
-# def __init__(self, seed: Optional[int] = 42, steps_per_episode: int = 30):
-# self._rng = np.random.RandomState(seed=seed)
-# self.user_history = []
-# self.steps_per_episode = steps_per_episode
-#
-# @staticmethod
-# def _get_user_selection_probabilities(user_id: str):
-# sessions = history.query(f"session_id == '{user_id}'")[["action", "reward"]]
-# sessions_unnested = sessions.explode("action")
-# sessions_unnested["reward"] = sessions_unnested.apply(
-# lambda df: df.action in df.reward, axis="columns"
-# )
-# return (
-# sessions_unnested.reset_index(drop=True)
-# .groupby("action")
-# .mean()
-# .rename(columns={"reward": "select_probability"})
-# .squeeze(axis="columns")
-# )
-#
-# def reset(self) -> Dict:
-# random_user = users.session_id.sample(1).values[0]
-# self.selection_probabilities = self._get_user_selection_probabilities(
-# random_user
-# )
-# self.step = 0
-# return {"user": random_user, "step": self.step}
-#
-# def step(self, action: str) -> Tuple:
-# simulate_selection = ...
-# return encoded_state, reward / 5, done, info
-#
-#
-# HomelikeApartmentSearch().reset()
diff --git a/docs/CNAME b/docs/CNAME
deleted file mode 100644
index 8b5a25a..0000000
--- a/docs/CNAME
+++ /dev/null
@@ -1 +0,0 @@
-deeprecsys.com
\ No newline at end of file
diff --git a/docs/api/deeprecsys/index.html b/docs/api/deeprecsys/index.html
index b940320..52dd46e 100644
--- a/docs/api/deeprecsys/index.html
+++ b/docs/api/deeprecsys/index.html
@@ -3,7 +3,7 @@
-
+
deeprecsys API documentation
@@ -26,7 +26,7 @@