Skip to content

Commit

Permalink
Fixed pylint errors (lava-nc#644)
Browse files Browse the repository at this point in the history
* Refactoring methods without arguments into functions.

Signed-off-by: Mathis Richter <[email protected]>

* Raising ValueError instead of str.

Signed-off-by: Mathis Richter <[email protected]>

* Defining members before use.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed pylint error about non-callable variable.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed deprecation warning.

Signed-off-by: Mathis Richter <[email protected]>

* Defined members before use.

Signed-off-by: Mathis Richter <[email protected]>

* Removed unused imports.

Signed-off-by: Mathis Richter <[email protected]>

* Removed unused variables.

Signed-off-by: Mathis Richter <[email protected]>

* Removed unnecessary pass statements.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed attributes defined outside __init__.

Signed-off-by: Mathis Richter <[email protected]>

* Activated linting checks in poetry.

Signed-off-by: Mathis Richter <[email protected]>

* Revert "Refactoring methods without arguments into functions."

This reverts commit 8dc55a3.

* Deactivated flake8 plugins for now.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed shadowing of built-in variable names.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed reimported modules.

Signed-off-by: Mathis Richter <[email protected]>

* Explicitly disabling plugins again.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed pointless string statement errors.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed linter errors for abstract methods.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed renamed arguments.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed calling init method of non-parent class.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed unit tests.

Signed-off-by: Mathis Richter <[email protected]>

* Ignored linter errors with subprocess module.

Signed-off-by: Mathis Richter <[email protected]>

* Ignored linter error about renamed variable.

Signed-off-by: Mathis Richter <[email protected]>

* Added a description on linter ignore.

Signed-off-by: Mathis Richter <[email protected]>

* Ignored arguments-differ linter error.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed unused-variable linter error.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed linter errors.

Signed-off-by: Mathis Richter <[email protected]>

* Reverted linter changes in runtime to fix unit tests in lava-loihi.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed remark issues in Markdown files.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed remark issues in Markdown files.

Signed-off-by: Mathis Richter <[email protected]>

* Fixed remark issues in Markdown files.

Signed-off-by: Mathis Richter <[email protected]>

---------

Signed-off-by: Mathis Richter <[email protected]>
  • Loading branch information
mathisrichter committed May 26, 2023
1 parent 486488e commit c44a9b8
Show file tree
Hide file tree
Showing 73 changed files with 393 additions and 513 deletions.
20 changes: 10 additions & 10 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@ Objective of issue:

**Lava version:**
<!-- remove versions not chosen below -->
- [ ] **0.6.0** (feature release)
- [ ] **0.5.1** (bug fixes)
- [x] **0.5.0** (current version)
- [ ] **0.4.1**
- [ ] **0.4.0**
- [ ] **0.3.0**
- [ ] **0.1.2**
- [ ] **0.6.0** (feature release)
- [ ] **0.5.1** (bug fixes)
- [x] **0.5.0** (current version)
- [ ] **0.4.1**
- [ ] **0.4.0**
- [ ] **0.3.0**
- [ ] **0.1.2**

**I'm submitting a ...**
<!-- (Mark one with "x") remove not chosen below -->
- [ ] bug report
- [ ] feature request
- [ ] documentation request
- [ ] bug report
- [ ] feature request
- [ ] documentation request

<!-- Please do not submit support requests or "How to" questions here, use discussions Q&A https://github.com/lava-nc/lava/discussions/categories/q-a -->

Expand Down
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ A clear and concise description of what the bug is.

**To reproduce current behavior**
Steps to reproduce the behavior:
1. When I run this code (add code or minimum test case) ...
1. When I run this code (add code or minimum test case) ...
```python
def my_code():
pass
```
2. I get this error ...
2. I get this error ...
```
Error...
```
Expand All @@ -39,9 +39,9 @@ A clear and concise description of what you expected to happen.
If applicable, add screenshots to help explain your problem. Remove section otherwise.

**Environment (please complete the following information):**
- Device: [e.g. Laptop, Intel cloud]
- OS: [e.g. Linux]
- Lava version [e.g. 0.6.1]
- Device: [e.g. Laptop, Intel cloud]
- OS: [e.g. Linux]
- Lava version [e.g. 0.6.1]

**Additional context**
Add any other context about the problem here. Remove section otherwise.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ assignees: ''
As a user, I want to [capability] to [benefit].

### Conditions of satisfaction
- An optional list of conditions that have to be fulfilled for this feature to be complete.
- For example: "Users can add both individual items and lists as parameters."
- An optional list of conditions that have to be fulfilled for this feature to be complete.
- For example: "Users can add both individual items and lists as parameters."

### Acceptance tests
- An optional list of tests that should be written to automatically test the new feature.
- An optional list of tests that should be written to automatically test the new feature.
32 changes: 16 additions & 16 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Objective of pull request:
## Pull request checklist
<!-- (Mark with "x") -->
Your PR fulfills the following requirements:
- [ ] [Issue](https://github.com/lava-nc/lava/issues) created that explains the change and why it's needed
- [ ] Tests are part of the PR (for bug fixes / features)
- [ ] [Docs](https://github.com/lava-nc/docs) reviewed and added / updated if needed (for bug fixes / features)
- [ ] PR conforms to [Coding Conventions](https://lava-nc.org/developer_guide.html#coding-conventions)
- [ ] [PR applys BSD 3-clause or LGPL2.1+ Licenses](https://lava-nc.org/developer_guide.html#add-a-license) to all code files
- [ ] Lint (`flakeheaven lint src/lava tests/`) and (`bandit -r src/lava/.`) pass locally
- [ ] Build tests (`pytest`) passes locally
- [ ] [Issue](https://github.com/lava-nc/lava/issues) created that explains the change and why it's needed
- [ ] Tests are part of the PR (for bug fixes / features)
- [ ] [Docs](https://github.com/lava-nc/docs) reviewed and added / updated if needed (for bug fixes / features)
- [ ] PR conforms to [Coding Conventions](https://lava-nc.org/developer_guide.html#coding-conventions)
- [ ] [PR applys BSD 3-clause or LGPL2.1+ Licenses](https://lava-nc.org/developer_guide.html#add-a-license) to all code files
- [ ] Lint (`flakeheaven lint src/lava tests/`) and (`bandit -r src/lava/.`) pass locally
- [ ] Build tests (`pytest`) passes locally


## Pull request type
Expand All @@ -30,13 +30,13 @@ Your PR fulfills the following requirements:
Please check your PR type:
<!-- (Mark one with "x") remove not chosen below -->

- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, renaming)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] Documentation changes
- [ ] Other (please describe):
- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, renaming)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] Documentation changes
- [ ] Other (please describe):


## What is the current behavior?
Expand All @@ -50,8 +50,8 @@ Please check your PR type:
## Does this introduce a breaking change?
<!-- (Mark one with "x") remove not chosen below -->

- [ ] Yes
- [ ] No
- [ ] Yes
- [ ] No

<!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. -->

Expand Down
29 changes: 10 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,22 +35,13 @@ supporting architectures like Intel Loihi may remain proprietary
to Intel and will be shared as extensions to eligible users.

>### Lava extension for Intel's Loihi
>The Lava extension for Loihi is available for members of the Intel
Neuromorphic Research Community (INRC). The extension enables execution of
Lava on Intel's Loihi hardware platform.
>The Lava extension for Loihi is available for members of the Intel Neuromorphic Research Community (INRC). The extension enables execution of Lava on Intel's Loihi hardware platform.
>
>Developers interested in using Lava with Loihi systems need to join the
INRC. Loihi 1 and 2 research systems are currently not available
commercially. Once a member of the INRC, developers will gain access to
cloud-hosted Loihi systems or may be able to obtain physical Loihi systems on a
loan basis.
>Developers interested in using Lava with Loihi systems need to join the INRC. Loihi 1 and 2 research systems are currently not available commercially. Once a member of the INRC, developers will gain access to cloud-hosted Loihi systems or may be able to obtain physical Loihi systems on a loan basis.
>
>To join the INRC, visit [http://neuromorphic.intel.com](http://neuromorphic.intel.com)
or email at [[email protected]](mailto:[email protected]).
>To join the INRC, visit [http://neuromorphic.intel.com](http://neuromorphic.intel.com) or email at [[email protected]](mailto:[email protected]).
>
> If you are already a member of the INRC, please read how to [get
started with the Lava extension for Loihi.](https://intel-ncl.atlassian.net/wiki/spaces/NAP/pages/1785856001/Get+started+with+the+Lava+extension+for+Loihi)
> This page is **only** accessible to members of the INRC.
> If you are already a member of the INRC, please read how to [get started with the Lava extension for Loihi](https://intel-ncl.atlassian.net/wiki/spaces/NAP/pages/1785856001/Get+started+with+the+Lava+extension+for+Loihi). This page is **only** accessible to members of the INRC.

# Getting started
Expand All @@ -70,7 +61,7 @@ will need to install the `poetry` Python package.

Open a **python 3** terminal and run based on the OS you are on:

### [Linux/MacOS]
### Linux/MacOS

```bash
cd $HOME
Expand All @@ -87,7 +78,7 @@ pytest
## See FAQ for more info: https://github.com/lava-nc/lava/wiki/Frequently-Asked-Questions-(FAQ)#install
```

### [Windows]
### Windows

```powershell
# Commands using PowerShell
Expand Down Expand Up @@ -140,7 +131,7 @@ Required test coverage of 85.0% reached. Total coverage: 88.81%
```

## [Alternative] Installing Lava via Conda
## Alternative: Installing Lava via Conda

If you use the Conda package manager, you can simply install the Lava package
via:
Expand All @@ -158,7 +149,7 @@ conda install -n lava -c intel numpy scipy
conda install -n lava -c conda-forge lava --freeze-installed
```

## [Alternative] Installing Lava from binaries
## Alternative: Installing Lava from binaries

If you only need to install Lava as a user in your python environment, we will
publish Lava releases via
Expand All @@ -167,7 +158,7 @@ the package and install it.

Open a Python terminal and run:

### [Windows/MacOS/Linux]
### Windows/MacOS/Linux

```bash
python -m venv .venv
Expand Down Expand Up @@ -203,7 +194,7 @@ bandit -r src/lava/.
bandit -r src/lava/. --format custom --msg-template '{abspath}:{line}: {test_id}[bandit]: {severity}: {msg}'
```
##
> Refer to the tutorials directory for in-depth as well as end-to-end tutorials on how to write Lava Processes, connect them, and execute the code.
>Refer to the tutorials directory for in-depth as well as end-to-end tutorials on how to write Lava Processes, connect them, and execute the code.
# Stay in touch

Expand Down
Loading

0 comments on commit c44a9b8

Please sign in to comment.