Auto-document Models and Datasets with AskAI Prompts
Last updated
Last updated
AskAI empowers data scientists to generate clear, tailored documentation for iterations, models, or datasets with ease. Whether using the “Ask Me Anything” feature for custom prompts or documenting directly from your assets using Macros, AskAI ensures all key details are documented seamlessly—so you can focus on your work, not the paperwork.
Below, we have crafted some basic prompts to get you started auto-documenting with AskAI.
To generate documentation based on your assets and phases, use AskAI's "Ask me anything" feature and use the /
character to select the desired assets or phrases.
The following AI prompt will summarize your model's technique, performance metrics and insert attachments.
Prompt output:
The following AI prompt will generate a detailed comparison of multiple models, highlighting differences in technique, training data, and results.
Prompt output:
Prompt to derive the feature engineering that happened between 2 datasets. The LLM will look at the distribution of the columns and all of the metadata and infer the feature engineering.
Prompt output:
Alternatively, you can provide more information to your Prompt to derive more based on iteration.
Prompt output:
The following prompt allows you to pass a table or CSV file directly into the prompt, enabling AskAI to analyze and summarize the data seamlessly. This option is ideal for generating insights, summaries, or comparisons based on structured data.
Use the "/" or "." character to effortlessly autocomplete prompts while typing, ensuring smooth and accurate asset integration.
Prompt output:
Alternatively, prompts can be found and inserted within macros. These prompts tend to be more intricate and often contain detailed expectations for the output, which are crucial for generating comprehensive documentation. Below are a few examples.
You can customize and modify predefined Macro Prompts to align them with your specific needs and requirements.
This is the prompt inside the macro 'Model overview'. These prompts are more complex and give you a predefined structure and tone of voice. Here, the prompt is just a standalone:
Once you run this macro, the results will look something like this:
This is the prompt inside the macro 'Model improvements'. It combines the macrostructure and a prompt to allow you to analyze the differences between models more thoroughly.
Here are the results of running this Macro prompt:
This is the prompt inside the macro 'Model alternatives'. As before, the advanced prompt can manage multiple model inputs.
The result of running this macro prompt:
Overall, AskAI combines ease of use with powerful prompts that you can customize, ensuring you can capture and communicate the value of your projects with minimal effort.