Symbols
loading x elements...

Symbols

Name Private Creator Description
info_column_types NO floriandietz@elody.com The comment of this Tag describes the datatype of a column. Valid values are: -primitive values like int32, int64, float32, float64, boolean, string, datetime, ... -special values: daily_date and daily_delta. Both of these are more specific variants of datetime and timedelta, where all values are full days (the hours, minutes, etc. are all 0). -categorical: Different values represent different categories. -numeric: Values can be ordered and basic mathematical functions can be applied to them. -discrete: Values are numeric and there is a finite number of values between any two values. -continuous: Values are numeric and there can be an infinite number of values between two values. -candidate_key: A different value for every entry and no null entries. Note that [[symbol:info_primary_key]] is used to mark the primary key separately. The purpose of this Tag is to inform other Rules and Programs so that they can make intelligent decision. Therefore, being useful is more important than being correct. An integer indicator variable that only has the value 0 and 1, for example, is technically numeric and discrete, but it may make more sense to mark it as categorical instead. The same is true for IDs and for other kinds of numeric values that fall into a suspiciously small number of clusters of different values. If multiple datatypes apply, separate them with commas. Add both leading and trailing commas to make search easier and safer by avoiding accidental prefix/postfix matches. Examples: -The name of the customer: ",string,categorical," -the ID of the item the customer bought: ",candidate_key,int64,int,categorical," -The date and time on which an item was bought: ",datetime,continuous,numeric," -The date on which the item is due (without a time component): ",daily_date,datetime,discrete,numeric," -The number of items the customer bought: ",int64,int,discrete,numeric," -The price the customer paid: ",float64,float,continuous,numeric," -The discount of the item: ",float64,float,continuous,numeric,categorical," Note the last example: If the discount is a number, but there are only a fixed number of different discount values, it can be useful both as a numeric value and as a categorical value, depending on the algorithm you want to use. Note that the datatype of the column should be flexible enough to allow all ways of treating the column specified by this Tag. For example, if we are dealing with a Pandas DataFrame and a column is marked as both numeric and categorical, then the column in the Pandas DataFrame should not be of type 'category' as that would make numeric operations impossible. Special case: The comment can be set to "TBD" (for to-be-determined) to indicate that this value needs to be redetermined. This is useful if a program alters the column but does not know how to describe the datatype. It leaves making that description up to other programs. Arguments of this Tag: 0 : A [[symbol:column]] Tag.
info_column_name NO floriandietz@elody.com The comment of this Tag describes the name of a column. It is null if the table is unnamed. Arguments of this Tag: 0 : A [[symbol:column]] Tag.
info_column_index NO floriandietz@elody.com The weight of this Tag describes the index of a column within a table. (Note that this is a separate Tag because it is possible to shift the index of a column, for instance by deleting another column in the same table. When that happens, you don't want to have to redefine the whole column and recreate all of its Tags. Instead, you can just update only this Tag and leave the rest as it is.) Arguments of this Tag: 0 : A [[symbol:column]] Tag.
info_table_row_count NO floriandietz@elody.com The weight of this Tag describes the number of rows of a table. Arguments of this Tag: 0 : Some object that represents a table, e.g. a file or a [[symbol:modifiable_file]].
info_table_name NO floriandietz@elody.com The comment of this Tag describes the name of a table. It is null if the table is unnamed. Arguments of this Tag: 0 : Some object that represents a table, e.g. a file or a [[symbol:modifiable_file]].
debug_mode NO floriandietz@elody.com This Tag is used to indicate that the user is a programmer who is interested in seeing debugging information. The comment of this Tag indicates which programs/rules/options are supposed to create debugging messages by mentioning them by name, in a list separated by commas. Use both leading and trailing commas to make accidental matches less likely: The Tag's comment says ",NameOfProgram1,NameOfProgram2,...," and the Program NameOfProgram1 checks for the presence of the string ",NameOfProgram1," DO NOT make your Program or Rule react to this Tag without verifying that its name is mentioned in the comment. Otherwise you make debugging harder for other people, since they will get your debugging information along with their own.
task_explore_data_for_pandas NO floriandietz@elody.com Defines a task to explore the content of a pickled Python Pandas. This task was defined alongside [[symbol:task_data_cleansing_and_analysis_for_pandas]] and executes afterwards, so you can assume that all of the data extracted by that task and stored in Tags will be available here and can be used to inform your choices of data exploration. Arguments of this Tag: 0 : A [[symbol:modifiable_file]].
require_present_table_column_info NO floriandietz@elody.com Indicates for a [[symbol:task_present_table_for_pandas]] that a Message describing one of the table's columns should be generated. This is separate from [[symbol:require_present_table_main_info]]. Bear in mind that the Messages for the columns should be created in the correct order. To ensure this, it helps to create the [[symbol:!offer]] Options in the order in which they should be executed and to give them all the same confidence. If you overwrite one of them, be sure to adjust the arguments and confidence of the replacement Option appropriately to ensure it executes at the right time. Arguments of this tag: 0 : A [[symbol:task_present_table_for_pandas]]. 2 : A [[symbol:column]]. Arguments of [[symbol:!offer]]: 0 : This Tag. 1 : An Option that would generate a Message. Arguments of [[symbol:!provide]]: 0 : This Tag. 1 : The Message.
require_present_table_main_info NO floriandietz@elody.com Indicates for a [[symbol:task_present_table_for_pandas]] that a Message describing the table as a whole should be generated. This is separate from [[symbol:require_present_table_column_info]]. Arguments of this tag: 0 : A [[symbol:task_present_table_for_pandas]]. Arguments of [[symbol:!offer]]: 0 : This Tag. 1 : An Option that would generate a Message. Arguments of [[symbol:!provide]]: 0 : This Tag. 1 : The Message.
task_present_table_for_pandas NO floriandietz@elody.com Defines a task to present the content of a pickled Python Pandas file to the user. This task was defined alongside [[symbol:task_data_cleansing_and_analysis_for_pandas]] and is supposed to run either during that task or after it, or both. Therefore, some of the data extracted by that task and stored in Tags may be available here, but you can't rely on it. This task is supposed to be solved automatically, without intervention by the user. Therefore, all Options involved in it should have a confidence above 500. Arguments of this Tag: 0 : A [[symbol:modifiable_file]].