Skip to main content

osu!mania score prediction through AI collaborative filtering

Project description

:arrow_forward: Try Out Opal on Streamlit

modelsize version pyversions https://img.shields.io/pypi/dm/opal-net

:comet: opal-net

opal is an accuracy-prediction model.

It uses Neural Collaborative Filtering to learn associations between user and maps, then using those associations to predict new scores never before seen.

Performance Error Graph Performance Graph

:hourglass_flowing_sand: Project Status

Currently, it's in its early access, that means, it'll have many problems! However, we're working on it to minimize these issues o wo)b

:arrow_double_down: Dataset Used

I used the top 10K mania users data from https://data.ppy.sh. After preprocessing, we use

  • ~10m scores for training
  • ~1m scores for validation and testing each

After preprocessing, we found ~30K valid users, ~10K valid maps This models can thus help predict ~300m unplayed scores!

Users

We deem a player on separate years as a different user. This is to reflect the improvement of the player after time.

:high_brightness: Usage

To use this, install opal-net

pip install opal-net

Then in a python script

from opal import OpalNet

# Load in the model
# You can explicitly specify map_location='cpu' or 'cuda' in map_location=...
opal = OpalNet.load()

# You can predict a single instance.
#
# The 1st arg: "<USER_ID>/<YEAR>",
# The 2nd arg: "<MAP_ID>/<SPEED>" 
#   <YEAR> is the year of the user to test.
#   <SPEED> can be {-1, 0, or 1} for {HT, NT, DT}
#
# For example: 
# Predict Evening on Year 2020, on the map Triumph & Regret [Regret] at Double Time
pred = opal.predict("2193881/2020", "767046/1")

# You can predict multiple entries at the same time. This is much faster that looping the above.
# Note that both lists must be of the same length!
# Note: If you're predicting millions, partition the predictions to reduce GPU memory usage!
preds = opal.predict(["2193881/2020", "2193881/2017"], ["767046/0", "767046/1"])

# Note that if the prediction doesn't exist, then it'll raise a ValueError
try:
    opal.predict("2193881/2018", "767046/0")
except ValueError:
    print("Prediction Failed!")

:brain: AlphaOsu!

Currently, opal doesn't provide recommendations, however, you can try out AlphaOsu!.

Annex

Why not Score Metric?

Score is not straightforward to calculate, and may be difficult to debug. Furthermore, score isn't of interest when calculating performance points anymore.

osu!mania ScoreV1 Reference

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

opal_net-2023.8.4.tar.gz (5.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

opal_net-2023.8.4-py3-none-any.whl (5.7 MB view details)

Uploaded Python 3

File details

Details for the file opal_net-2023.8.4.tar.gz.

File metadata

  • Download URL: opal_net-2023.8.4.tar.gz
  • Upload date:
  • Size: 5.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.0 CPython/3.11.0 Windows/10

File hashes

Hashes for opal_net-2023.8.4.tar.gz
Algorithm Hash digest
SHA256 e3e7b4701f79c90cfc7f6a7169411816e464e3913b035ac0408088594f485f70
MD5 d81cea32bb79419e528bc27b790ae641
BLAKE2b-256 c8b1f2e8cce250015f6d57965e2416799026605d20fca2f1f2da2a7c887ebbcc

See more details on using hashes here.

File details

Details for the file opal_net-2023.8.4-py3-none-any.whl.

File metadata

  • Download URL: opal_net-2023.8.4-py3-none-any.whl
  • Upload date:
  • Size: 5.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.0 CPython/3.11.0 Windows/10

File hashes

Hashes for opal_net-2023.8.4-py3-none-any.whl
Algorithm Hash digest
SHA256 59e9e70175305b30b880bd463c284a5d8028e5229aba51d5746bd188ddad49ea
MD5 7db13154b4ce177fe62aa07f455e6ce7
BLAKE2b-256 6a08d56e3bd5fe4e68776caf04ed619334380549daec5fe2909f03cdfcc74124

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page