Skip to content

Commit

Permalink
Release 2.0 (#4)
Browse files Browse the repository at this point in the history
- Add Contextual MAB (LinUCB, SWLinUCB) a.k.a CONSTANTINE
- Big Code Refactoring
  • Loading branch information
jacksonpradolima authored Sep 9, 2023
2 parents c78b36d + 07eb294 commit ff167d9
Show file tree
Hide file tree
Showing 30 changed files with 770,724 additions and 818 deletions.
12 changes: 12 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# CONFIG
CONFIG_FILE=./config.toml
59 changes: 59 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<!-- Preambule -->

## Please follow the guide below

- You will be asked some questions, please read them **carefully** and answer honestly
- Put an `x` into all the boxes [ ] relevant to your *pull request* (like that [x])
- Use *Preview* tab to see how your *pull request* will actually look like

---

### Before submitting a *pull request* make sure you have:
- [ ] The *pull request* title contains a meaningful title
- Short and informative: serves as a summary
- [ ] At least skimmed through the coding conventions used in the project
- [ ] Checked the code with [flake8](https://pypi.python.org/pypi/flake8)
- [ ] Performed a self-review of my own code
- [ ] The code is commented, particularly in hard-to-understand areas
- [ ] The documentation associated was created or updated
- [ ] The changes generate no new warnings
- [ ] Add tests that prove the change is effective or that the feature works
- [ ] New and existing unit tests pass locally with the changes
- [ ] Any dependent changes have been merged and published in downstream modules


---
<!-- Describe what you've done -->

# Contents of the *Pull Request*

Explanation of your *pull request* in arbitrary form goes here. Please make sure the description explains the purpose and effect of your *pull request* and is worded well enough to be understood. Provide as much context and examples as possible. For instance, how this *pull request* contributes to the project.

# Stacked PR Chains (Optional)

Please include list of stacked PR chains, and showing the dependency tree.

# Recording (Optional)

Provide a video that contains a summary of the change.

You can use [Loom](https://www.loom.com/).

# How Has This Been Tested? (Required)

It can be useful also to tell the testers or reviewers how to deal with the feature, how to test it or if there is some new environment setup that should be done to test the feature.

In this sense, please describe the tests or the test plan that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

- [ ] Test A
- [ ] Test B

**Test Configuration**:
* Firmware version:
* Hardware:
* Toolchain:
* SDK:

# Other Notes

(Add any additional information that would be useful)
16 changes: 16 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
- package-ecosystem: "github-actions"
directory: ".github/workflows"
schedule:
interval: "daily"

- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "daily"
55 changes: 55 additions & 0 deletions .github/workflows/pylint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Pylint

on:
pull_request:
types: [opened, synchronize, reopened, edited, ready_for_review]

jobs:
pylint:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3
with:
fetch-depth: 0 # To retrieve the preceding commit (deeply).

- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.11

- name: Install dependencies
run: python -m pip install pylint

- name: Create Pylintrc file
run: |
echo "[MASTER]" > .pylintrc
echo "init-hook=\"from pylint.config import find_pylintrc; import os, sys; sys.path.append(os.path.dirname(find_pylintrc())+ '/web')\"" >> .pylintrc
echo "max-line-length=120" >> .pylintrc
echo "disable=" >> .pylintrc
echo " C0103, # uppercase naming style" >> .pylintrc
echo " logging-format-interpolation, # use %s for logging" >> .pylintrc
echo " broad-except, # we want to catch all exceptions" >> .pylintrc
echo " too-many-locals, # we don't care" >> .pylintrc
echo " too-few-public-methods, # enum classes don't normally have methods" >> .pylintrc
echo " too-many-instance-attributes," >> .pylintrc
echo " too-many-arguments," >> .pylintrc
echo " import-error," >> .pylintrc
echo " attribute-defined-outside-init," >> .pylintrc
echo " redefined-outer-name" >> .pylintrc
- name: Get Python changed files
id: changed-py-files
uses: tj-actions/changed-files@v35
with:
files: |
*.py
**/*.py
- name: Run pylint step if python files changed
if: steps.changed-py-files.outputs.any_changed == 'true'
run: |
echo "One or more py files not in the doc folder has changed."
echo "List all the files that have changed: ${{ steps.changed-py-files.outputs.all_changed_files }}"
pylint --rcfile .pylintrc ${{ steps.changed-py-files.outputs.all_changed_files }}
14 changes: 14 additions & 0 deletions .pylintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[MASTER]
init-hook="from pylint.config import find_pylintrc; import os, sys; sys.path.append(os.path.dirname(find_pylintrc()))"
max-line-length=120
disable=
C0103, # uppercase naming style
logging-format-interpolation, # use %s for logging
broad-except, # we want to catch all exceptions
too-many-locals, # we don't care
too-few-public-methods, # enum classes don't normally have methods
too-many-instance-attributes,
too-many-arguments,
import-error,
attribute-defined-outside-init,
redefined-outer-name
Loading

0 comments on commit ff167d9

Please sign in to comment.