Flaky test on Windows for REM

[purva-thakre]

Description

Fixes #2431 by increasing the sample size. Increasing the sample size does not increase the run time by a lot.

Sample Size	Time (in Seconds)
1000	0.02572114800204872
10000	0.2219564580009319

This PR also splits up the docs build portion of the github workflows from everything else. This lets us rerun the pytest workflows without requiring us to rerun the docs job.

---

License

• I license this contribution under the terms of the GNU GPL, version 3 and grant Unitary Fund the right to provide additional permissions as described in section 7 of the GNU GPL, version 3.

Before opening the PR, please ensure you have completed the following where appropriate.

• I added unit tests for new code.
• I used type hints in function signatures.
• I used Google-style docstrings for functions.
• I updated the documentation where relevant.
• Added myself / the copyright holder to the AUTHORS file

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.70%. Comparing base (e61c058) to head (6c5f350).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2437   +/-   ##
=======================================
  Coverage   98.70%   98.70%           
=======================================
  Files          88       88           
  Lines        4083     4083           
=======================================
  Hits         4030     4030           
  Misses         53       53           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[purva-thakre]

I think increasing the sample size should fix the failures i.e this PR is technically ready.

Will try to rerun the workflow a couple of times to make sure of this. I can't test it locally because I don't have access to a windows device.

[purva-thakre]

windows-python3.10 is failing due to installation issues.

https://github.com/unitaryfund/mitiq/actions/runs/9778773532/job/27001295996?pr=2437#step:4:892

[purva-thakre]

running the tests 4 times did not lead to any failures in the linked issue.

Noticed a macos failure which is different from the test in this PR.
https://github.com/unitaryfund/mitiq/actions/runs/9778773532/job/27007243754?pr=2437#step:6:4363

[purva-thakre]

as discussed during the community call today, we want to wait for #2441 to be merged before rebasing this PR.

@jordandsullivan and @cosenal raised a point that we should look into what's causing this failure instead of simply raising the sample size to ensure the test passes.

[purva-thakre]

The function in the failing unit test relies on np.random.choice. The performance of numpy on windows is affected as discussed in the numpy repo.

mitiq/mitiq/rem/inverse_confusion_matrix.py

Line 30 in e61c058

choices = np.random.choice(num_values, size=samples, p=probability_vector)

I still cannot understand why the test would fail/pass at random on windows/python3.11 or windows/python3.12,

[purva-thakre]

closing due to #2431 (comment)