Internal API

These pages document the entire internal API

• django-river-ml package
  • Submodules
  • django_river_ml.announce module
    • MessageAnnouncer
      • MessageAnnouncer.announce()
      • MessageAnnouncer.listen()
  • django_river_ml.apps module
    • DjangoRiverMLConfig
      • DjangoRiverMLConfig.name
      • DjangoRiverMLConfig.ready()
      • DjangoRiverMLConfig.verbose_name
  • django_river_ml.auth module
    • generate_jwt()
    • get_challenge()
    • get_token()
    • get_user()
    • is_authenticated()
    • validate_jwt()
  • django_river_ml.client module
    • DjangoClient
      • DjangoClient.add_model()
      • DjangoClient.announce_event()
      • DjangoClient.announce_metrics()
      • DjangoClient.delete_id()
      • DjangoClient.delete_model()
      • DjangoClient.finish_learn()
      • DjangoClient.get_model()
      • DjangoClient.label()
      • DjangoClient.learn()
      • DjangoClient.load_model()
      • DjangoClient.make_prediction()
      • DjangoClient.metrics()
      • DjangoClient.models()
      • DjangoClient.predict()
      • DjangoClient.save_model()
      • DjangoClient.save_pickle()
      • DjangoClient.stats()
      • DjangoClient.update_metrics()
    • RiverClient
      • RiverClient.add_model()
      • RiverClient.delete_id()
      • RiverClient.delete_model()
      • RiverClient.get_model()
      • RiverClient.label()
      • RiverClient.learn()
      • RiverClient.make_prediction()
      • RiverClient.metrics()
      • RiverClient.models()
      • RiverClient.predict()
      • RiverClient.stats()
      • RiverClient.stream_events()
      • RiverClient.stream_metrics()
  • django_river_ml.exceptions module
    • FlavorNotSet
    • InvalidUsage
      • InvalidUsage.status_code
      • InvalidUsage.to_dict()
    • UnknownFlavor
  • django_river_ml.flavors module
    • BinaryFlavor
      • BinaryFlavor.check_model()
      • BinaryFlavor.default_metrics()
      • BinaryFlavor.name
      • BinaryFlavor.pred_funcs
    • ClusterFlavor
      • ClusterFlavor.check_model()
      • ClusterFlavor.default_metrics()
      • ClusterFlavor.name
      • ClusterFlavor.pred_funcs
    • CremeFlavor
      • CremeFlavor.check_model()
      • CremeFlavor.default_metrics()
      • CremeFlavor.learn_func
      • CremeFlavor.name
      • CremeFlavor.pred_funcs
    • CustomFlavor
      • CustomFlavor.check_model()
      • CustomFlavor.default_metrics()
      • CustomFlavor.name
      • CustomFlavor.pred_funcs
    • Flavor
      • Flavor.check_model()
      • Flavor.default_metrics()
      • Flavor.learn_func
      • Flavor.name
      • Flavor.pred_funcs
    • MultiClassFlavor
      • MultiClassFlavor.check_model()
      • MultiClassFlavor.default_metrics()
      • MultiClassFlavor.name
      • MultiClassFlavor.pred_funcs
    • NeighborFlavor
      • NeighborFlavor.check_model()
      • NeighborFlavor.default_metrics()
      • NeighborFlavor.name
      • NeighborFlavor.pred_funcs
    • RegressionFlavor
      • RegressionFlavor.check_model()
      • RegressionFlavor.default_metrics()
      • RegressionFlavor.name
      • RegressionFlavor.pred_funcs
    • all_models()
    • allowed_flavors()
    • check()
  • django_river_ml.middleware module
    • timer_middleware()
  • django_river_ml.model module
    • model_to_dict()
  • django_river_ml.namer module
    • Namer
      • Namer.generate()
  • django_river_ml.settings module
    • generate_secret_keys()
  • django_river_ml.signals module
    • create_auth_token()
    • create_user_token()
    • get_user_token()
  • django_river_ml.storage module
    • RedisBackend
      • RedisBackend.close()
    • ShelveBackend
    • StorageBackend
      • StorageBackend.close()
      • StorageBackend.get()
    • add_model()
    • close_db()
    • delete_model()
    • drop_db()
    • get_db()
    • init_metrics()
    • init_stats()
    • set_flavor()
  • django_river_ml.urls module
  • django_river_ml.utils module
    • format_sse()
    • get_server()
    • humanize_ns()
  • django_river_ml.version module
  • django_river_ml.views module
  • django_river_ml.views.auth module
    • GetAuthToken
      • GetAuthToken.allowed_methods
      • GetAuthToken.authentication_classes
      • GetAuthToken.get()
      • GetAuthToken.permission_classes
  • django_river_ml.views.base module
  • django_river_ml.views.learn module
  • django_river_ml.views.metrics module
  • django_river_ml.views.model module
  • django_river_ml.views.predict module