Skip to content

Commit

Permalink
Minor edits (#561)
Browse files Browse the repository at this point in the history
* doc : RELEASE.md updated

* doc : README.md installation section updated

* doc : CI badges bugs fixed

* doc : Distance.ipynb updated

* doc : README.md installation section updated
  • Loading branch information
sepandhaghighi authored Oct 13, 2024
1 parent de6a7bc commit 9f41376
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions Document/Distance.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2882,7 +2882,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## KuderRichardson"
"## Kuder & Richardson"
]
},
{
Expand Down Expand Up @@ -2935,7 +2935,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## KuhnsI"
"## Kuhns I"
]
},
{
Expand Down Expand Up @@ -2992,7 +2992,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## KuhnsII"
"## Kuhns II"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion Otherfiles/RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# PyCM Release Instructions

**Last Update: 2024-08-06**
**Last Update: 2024-10-11**

1. Create the `release` branch under `dev`
2. Update all version tags
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ PyCM is the swiss-army knife of confusion matrices, targeted mainly at data scie
</tr>
<tr>
<td align="center">CI</td>
<td align="center"><img src="https://github.com/sepandhaghighi/pycm/workflows/CI/badge.svg?branch=master"></td>
<td align="center"><img src="https://github.com/sepandhaghighi/pycm/workflows/CI/badge.svg?branch=dev"></td>
<td align="center"><img src="https://github.com/sepandhaghighi/pycm/actions/workflows/test.yml/badge.svg?branch=master"></td>
<td align="center"><img src="https://github.com/sepandhaghighi/pycm/actions/workflows/test.yml/badge.svg?branch=dev"></td>
</tr>
</table>

Expand All @@ -75,25 +75,25 @@ PyCM is the swiss-army knife of confusion matrices, targeted mainly at data scie
### PyPI

- Check [Python Packaging User Guide](https://packaging.python.org/installing/)
- Run `pip install pycm==4.0` (Need root access)
- Run `pip install pycm==4.0`

### Source code
- Download [Version 4.0](https://github.com/sepandhaghighi/pycm/archive/v4.0.zip) or [Latest Source](https://github.com/sepandhaghighi/pycm/archive/dev.zip)
- Run `pip install .` (Need root access)
- Run `pip install .`

### Conda

- Check [Conda Managing Package](https://conda.io/)
- Update Conda using `conda update conda` (Need root access)
- Run `conda install -c sepandhaghighi pycm` (Need root access)
- Update Conda using `conda update conda`
- Run `conda install -c sepandhaghighi pycm`

### MATLAB

- Download and install [MATLAB](https://www.mathworks.com/products/matlab.html) (>=8.5, 64/32 bit)
- Download and install [Python3.x](https://www.python.org/downloads/) (>=3.6, 64/32 bit)
- [x] Select `Add to PATH` option
- [x] Select `Install pip` option
- Run `pip install pycm` or `pip3 install pycm` (Need root access)
- Run `pip install pycm`
- Configure Python interpreter

```matlab
Expand Down

0 comments on commit 9f41376

Please sign in to comment.