Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor edits #561

Merged
merged 5 commits into from
Oct 13, 2024
Merged

Minor edits #561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b1f556c
doc : RELEASE.md updated
sepandhaghighi Oct 11, 2024
1de654e
doc : README.md installation section updated
sepandhaghighi Oct 11, 2024
43c6897
doc : CI badges bugs fixed
sepandhaghighi Oct 11, 2024
50520ee
doc : Distance.ipynb updated
sepandhaghighi Oct 12, 2024
15d10bf
doc : README.md installation section updated
sepandhaghighi Oct 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Document/Distance.ipynb
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is not working, right?

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be resolved after updating the master branch.

<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
Loading