neural_prophet

Veuillez noter que le projet est encore en phase bêta. Veuillez signaler tout problème que vous rencontrez ou toute suggestion que vous avez. Nous ferons de notre mieux pour y remédier rapidement. Les contributions sont les bienvenues !

NeuralProphet : des prévisions centrées sur l'humain

NeuralProphet est un cadre facile à apprendre pour la prévision de séries chronologiques interprétables. NeuralProphet est construit sur PyTorch et combine des réseaux de neurones et des algorithmes de séries chronologiques traditionnels, inspirés de Facebook Prophet et AR-Net.

• Avec quelques lignes de code, vous pouvez définir, personnaliser, visualiser et évaluer vos propres modèles de prévision.
• Il est conçu pour la création itérative de modèles humains dans la boucle. Cela signifie que vous pouvez construire un premier modèle rapidement, interpréter les résultats, l'améliorer, répéter. En raison de l'accent mis sur l'interprétabilité et la capacité de personnalisation, NeuralProphet n'est peut-être pas le modèle le plus précis prêt à l'emploi ; alors n'hésitez pas à ajuster et à répéter jusqu'à ce que vous aimiez vos résultats.
• NeuralProphet est mieux adapté aux données de séries chronologiques de fréquence plus élevée (sous-quotidienne) et de durée plus longue (au moins deux périodes/années complètes).

Documentation

La page de documentation n'est peut-être pas entièrement à jour. Les Docstrings doivent être fiables, veuillez vous y référer en cas de doute. Nous travaillons sur une documentation améliorée. Nous apprécions toute aide pour améliorer et mettre à jour la documentation.

Pour une introduction visuelle à NeuralProphet, consultez cette présentation.

Contribuer

Nous avons compilé une page de contribution à NeuralProphet avec des instructions pratiques et des ressources supplémentaires pour vous aider à faire partie de la famille.

Communauté

Discussion et aide

Si vous avez des questions ou des suggestions, vous pouvez participer à notre communauté ici même sur Github

Chat Slack

Nous avons également une communauté Slack active. Venez participer à la conversation !

Tutoriels

Il existe plusieurs exemples de blocs-notes pour vous aider à démarrer.

Vous pouvez trouver les ensembles de données utilisés dans les didacticiels, y compris des exemples de prétraitement des données, dans notre référentiel neuralprophet-data.

Veuillez vous référer à notre page de documentation pour plus de ressources.

Exemple minimal

 from neuralprophet import NeuralProphet

Après avoir importé le package, vous pouvez utiliser NeuralProphet dans votre code :

 m = NeuralProphet ()
metrics = m . fit ( df )
forecast = m . predict ( df )

Vous pouvez visualiser vos résultats avec les fonctions de traçage intégrées :

 fig_forecast = m . plot ( forecast )
fig_components = m . plot_components ( forecast )
fig_model = m . plot_parameters ()

Si vous souhaitez faire des prévisions dans un avenir inconnu, étendez la trame de données avant de prédire :

 m = NeuralProphet (). fit ( df , freq = "D" )
df_future = m . make_future_dataframe ( df , periods = 30 )
forecast = m . predict ( df_future )
fig_forecast = m . plot ( forecast )

Installer

Vous pouvez maintenant installer neuralprophet directement avec pip :

pip install neuralprophet

Options d'installation

Si vous envisagez d'utiliser le package dans un notebook Jupyter, nous vous recommandons d'installer la version « live » :

pip install neuralprophet[live]

Cela vous permettra d'activer plot_live_loss dans la fonction fit pour obtenir un tracé en direct de la perte de train (et de validation).

Si vous souhaitez la version la plus récente, vous pouvez l'installer directement depuis github :

git clone < copied link from github >
cd neural_prophet
pip install .

Remarque pour les utilisateurs Windows : veuillez utiliser WSL2.

Caractéristiques

Composants du modèle

• Autorégression : Modélisation d'autocorrélation - linéaire ou NN (AR-Net).
• Tendance : tendance linéaire par morceaux avec détection automatique des points de changement en option.
• Saisonnalité : termes de Fourier à différentes périodes telles que annuelle, quotidienne, hebdomadaire, horaire.
• Régresseurs retardés : observations décalées (par exemple, capteur de température) - linéaires ou NN.
• Futurs régresseurs : caractéristiques connues à l'avance (par exemple, prévision de température) - linéaires ou NN.
• Événements : vacances à la campagne et événements personnalisés récurrents.
• Modélisation globale : les composants peuvent être locaux, globaux ou « glocal » (global + local régularisé)

Fonctionnalités du framework

• Séries chronologiques multiples : ajustez un modèle global/glocal avec des paramètres de modèle (partiellement) partagés.
• Incertitude : Estimation des valeurs de quantiles spécifiques - Régression quantile.
• Régularisez les composants de modélisation.
• Traçage des composants de prévision, des coefficients du modèle et bien plus encore.
• Utilitaire de validation croisée de séries chronologiques.
• Point de contrôle et validation du modèle.

À venir ^™️

• Relation croisée des régresseurs retardés.
• Régression de métadonnées statiques pour plusieurs séries
• Croissance logistique pour la composante tendance.

Pour une liste des modifications passées, veuillez vous référer à la page des versions.

Citer

Veuillez citer NeuralProphet dans vos publications si cela aide votre recherche :

 @misc{triebe2021neuralprophet,
      title={NeuralProphet: Explainable Forecasting at Scale}, 
      author={Oskar Triebe and Hansika Hewamalage and Polina Pilyugina and Nikolay Laptev and Christoph Bergmeir and Ram Rajagopal},
      year={2021},
      eprint={2111.15397},
      archivePrefix={arXiv},
      primaryClass={cs.LG}
}

Un grand merci à nos contributeurs :

À propos

NeuralProphet est un projet communautaire open source, soutenu par des personnes formidables comme vous. Si vous souhaitez rejoindre le projet, n'hésitez pas à me contacter (Oskar) - vous pouvez trouver mon e-mail sur le NeuralProphet Paper.