RosaeNLG Documentation

This is the documentation for 2.1.9 version, which is not the latest version. Consider upgrading to 3.0.1.
RosaeNLG logo

Introduction

RosaeNLG is a Natural Language Generation library for node.js or client side (browser) execution, based on the Pug template engine. It was previously known as FreeNLG.

Fully supported languages (with grammar, gender etc.) are English, French, German, Italian and Spanish but you can generate texts in any other language with less features.

RosaeNLG is complete enough to write production grade real life NLG applications.

RosaeNLG is a Sandbox Project of LF AI & Data Foundation, part of the Linux Foundation.

Static

Where to start

To start, use the Quick Start and the Tutorials and Examples. Then read carefully and respectfully the Reference Documentation.

If you wonder about NLG, see What is NLG and its usecases. You can also check the detailed characteristics of RosaeNLG.

French demos are available.

You can also play around with a client side editor, compiler and renderer with an in browser editor or directly here:

About the documentation

The main documentation site is rosaenlg.org. A mirror is available on Github pages, but without the search bar.

License

RosaeNLG is open source, with most code available under the Apache 2.0 license, and documentation under Creative Commons Attribution 4.0 International (CC-BY-4.0) license, though some elements are necessarily licensed under different open source licenses for compatibility with upstream licensing or code linking. For instance, english-ordinals and rosaenlg-cli modules remain under MIT.

The licenses applicable to each linguistic resource package are included in each subfolder the package directory, and a summary of the licenses can be found in the Linguistic resources documentation.