Package: rasa-model-report
Simple open-source Rasa command-line add-on that generates training model health reports for your projects.🔍 AboutRasais the most popular open-source framework for building chat and voice-based AI assistants. Therasa-model-reportis a unofficial Rasa add-on to facilitate the work of developers and curators of Rasa chatbots. Rasa provides a lot of valuable data that can be "faceted" and extract different information about the training model. This information makes it possible to discover problems in the training model. Therasa-model-reportdoes just that, it extracts this information to be displayed more clearly in a report. You can seethisexample.rasa-model-reportis an open-source project.☕ DonateYou can collaborate with this project donating any amount. Thanks! ☕📜 ChangelogChangelog can be foundhere. You can also follow thereleaseson Github and find planned enhancements for project in theProject Board.📦 InstallationThis module is distributed viaPypiand is required to usePython v3.8or higher. To install the package, use the command:pip install rasa-model-report🚀 ExecutionBefore anything, is necessary to have the reports generated by therasa testcommand. To run the program, use the command:rasa-model-reportThis command must be used in the root of your Rasa project. Otherwise, you can use--pathparameter to pass the project path.Step-by-stepThis is the step-by-step guide for usingrasa-model-reportin your project.Go to the root folder of your Rasa project.Train model on your Rasa project usingrasa traincommand.Run Rasa end-to-end tests usingrasa testcommand.This command will generate some data in json, markdown and image files inresult/directory.This datais neededforrasa-model-reportto generate the report.(Optional) If you want to know model NLU rating for each sentence in your project, run your project's Rasa API through the commandrasa run --enable-api.When you runrasa-model-report, automatically it will request NLU rating for each sentence. The result will be in theNLUsection of the report.If you don't want to use this option, just pass the parameter--disable-nluor don't run Rasa API (if you don't run Rasa API,rasa-model-reportwill try to connect, after two tries it will skip this step).Runrasa-model-reportin root project.If you haven't installed it, seehow to install.The result will be in themodel_report.mdfile generated in the project root folder.Below, I created this video to show how to use therasa-model-report v1.0.0. I used the Rasa sample project (fromrasa-initcommand). In thislinkis the generated report.https://github.com/brunohjs/rasa-model-report/assets/26513013/953e5792-e2d8-426a-8d43-2db8941a93e4Furthermore, I used the tool inSara - the Rasa Demo Bot. The result you can checkhere.🦾 Rasa Version SupportNot every version of Rasa is supported. Check the table below:Rasa versionSupported3.X✅2.X✅1.X❌0.X❌⚙️ OptionsThere are parameters that can be used. Available options are below:--actions-path TEXT     Actions path. (default: actions/ inside Rasa project
                        path)
--disable-nlu           Disable processing NLU sentences. NLU section will
                        not be generated in the report. Required Rasa API.
-e, --exclude LIST      List of utter and actions that will be exclude in
                        the E2E test coverage. Use commas to separate items.
                        Example: utter_greet,utter_goodbye,action_listen
-h, --help              Show this help message.
--model-link TEXT       Model download link. It's only displayed in the
                        report to model download.
--no-images             Generate model report without images.
--output-path TEXT      Report output path. (default: ./)
-p, --path TEXT         Rasa project path. (default: ./)
--precision INTEGER     Score precision. Used to change precision of the
                        model report overview scores. Can vary between 0 and
                        5 (default: 2)
--project-name TEXT     Rasa project name. It's only displayed in the
                        report. (default: My project)
--project-version TEXT  Project version. It's only displayed in the report
                        for project documentation.
--rasa-api TEXT         Rasa API URL. Is needed to create NLU section of
                        report. (default: http://localhost:5005)
--rasa-version TEXT     Rasa version. It's only displayed in the report for
                        project documentation.
-v, --version           Show installed rasa-model-report version.Usage examplesSome usage examples with parameters:Without parameters is usually used at the root of the Rasa project.rasa-model-reportWhen you aren't at the root of the project, use--pathparameter.rasa-model-report --path path/to/rasa/projectAren't at the root of the project and without NLU report.rasa-model-report --path path/to/rasa/project --disable-nluAren't at the root of the project and change the report output directory.rasa-model-report --path path/to/rasa/project --output-path path/to/place/reportAren't at the root of the project, the actions path isn't at the root project and change the report output directory.rasa-model-report --path path/to/rasa/project --output-path path/to/place/report --actions-path path/to/actions/pathIf you want exclude some utters and actions from the E2E test coverage.rasa-model-report --exclude utter_greet,action_help💻 DevelopmentThe instructions for development and contributing are in theCONTRIBUTING.mdfile.🐞 BugsPlease file an issue for bugs, missing documentation, or unexpected behavior.See open issues💬 DiscussionsPlease file an issue to suggest new features. Vote on feature requests. This helps maintainers prioritize what to work on.See new ideas discussion❓ QuestionsFor questions related to using the add-on, please ask the community on Q&A.See Q&A