[BUG] UnicodeDecodeError During pip install . in Mithril Package

[AlperenOvak]

Bug Report

Describe the Bug

When running pip install . inside the mithril package directory, the installation fails with a UnicodeDecodeError. The error occurs while reading setup.py, specifically while reading the long_description file. The error message suggests that the file contains characters that cannot be decoded using the default cp1252 encoding on Windows.

To Reproduce

1. Clone the repository or navigate to the mithril package directory.
2. Run:

   pip install .  

3. The installation fails with the following traceback:

   UnicodeDecodeError: 'charmap' codec can't decode byte 0x8f in position 2275: character maps to <undefined>
   

Expected Behavior

The package should install without errors.

Additional Context

The issue is likely caused by the long_description field in setup.py when reading README.md or another file.

System Info

• OS: Windows 10/11
• Mithril Version: 0.1.1
• Torch Version: 2.6.0+cpu
• MLX Version: NaN
• NumPy Version: 2.2.3
• JAX Version: NaN
• Python Version: 3.12.9
• Architecture: x64