Update README.md

README.md

@@ -38,6 +38,7 @@ The first dataset is `ui_tables` which aims to store the information from the Do
 ## Dataset Structure
 
 ### Data Instance
+An instance of `ui_survey` (here, index 13) looks like
 ```json
 {
   "table_id": "2-5",
@@ -45,8 +46,22 @@ The first dataset is `ui_tables` which aims to store the information from the Do
   "table_description": "Details of years used for benefits and payrolls in benefit-wage-ratio formula states",
   "notes": "",
   "table_data": "[{'state': 'DE', 'years_of_benefits_used': 'Last 3 years', 'years_of_payrolls_used': 'Last 3 years'}, {'state': 'OK', 'years_of_benefits_used': 'Last 3 years', 'years_of_payrolls_used': 'Last 3 years'}]", 'chapter': '2', 'headers': "{'state': string[python], 'years_of_benefits_used': string[python], 'years_of_payrolls_used': string[python]}", 'prompt_context': 'BENEFIT-WAGE-RATIO FORMULA—The benefit-wage-ratio formula is significantly different from the other formulas. It makes no attempt to measure all benefits paid to the workers of individual employers. The relative experience of employers is measured by the separations of workers which result in benefit payments, but the duration of their benefits is not a factor. The separations, weighted with the wages earned by the workers with each base period employer, are recorded on each employer’s experience rating record as “benefit wages.” Only one separation per beneficiary per benefit year is recorded for any one employer. The index which is used to establish the relative experience of employers is the proportion of each employer’s payroll which is paid to those workers who become unemployed and receive benefits (i.e., the ratio of an employer’s benefit wages to total taxable wages). The ratio of total benefit payments and total benefit wages, known as the state experience factor, means that, on average, the workers who drew benefits received a certain amount of benefits for each dollar of benefit wages paid and the same amount of taxes per dollar of benefit wages is needed to replenish the fund. The total amount to be raised is distributed among employers in accordance with their benefit-wage-ratios; the higher the ratio, the higher the rate. \nIndividual employer rates are determined by multiplying the employer’s experience factor by the state experience factor. The multiplication is facilitated by a table, which assigns rates that are the same as, or slightly more than, the product of the employer’s benefit-wage-ratio and the state factor.', 'prompts': "['Given the description above, what are the years of benefits used to calculate the benefit-wage ratio in {jurisdiction}?', 'Given the description above, what are the years of payrolls used to calculate the benefit-wage ratio in {jurisdiction}?']"
+  "chapter": "2",
+  "headers": "{'state': string[python], 'years_of_benefits_used': string[python], 'years_of_payrolls_used': string[python]}",
+  "prompt_context": "BENEFIT-WAGE-RATIO FORMULA—The benefit-wage-ratio formula is significantly different from the other formulas. It makes no attempt to measure all benefits paid to the workers of individual employers. The relative experience of employers is measured by the separations of workers which result in benefit payments, but the duration of their benefits is not a factor. The separations, weighted with the wages earned by the workers with each base period employer, are recorded on each employer’s experience rating record as “benefit wages.” Only one separation per beneficiary per benefit year is recorded for any one employer. The index which is used to establish the relative experience of employers is the proportion of each employer’s payroll which is paid to those workers who become unemployed and receive benefits (i.e., the ratio of an employer’s benefit wages to total taxable wages). The ratio of total benefit payments and total benefit wages, known as the state experience factor, means that, on average, the workers who drew benefits received a certain amount of benefits for each dollar of benefit wages paid and the same amount of taxes per dollar of benefit wages is needed to replenish the fund. The total amount to be raised is distributed among employers in accordance with their benefit-wage-ratios; the higher the ratio, the higher the rate. \nIndividual employer rates are determined by multiplying the employer’s experience factor by the state experience factor. The multiplication is facilitated by a table, which assigns rates that are the same as, or slightly more than, the product of the employer’s benefit-wage-ratio and the state factor.",
+  "prompts": "['Given the description above, what are the years of benefits used to calculate the benefit-wage ratio in {jurisdiction}?', 'Given the description above, what are the years of payrolls used to calculate the benefit-wage ratio in {jurisdiction}?']"
 }
 ```
+where in this instance
+```python
+>>> pd.DataFrame.from_records(table_data[13])
+  state years_of_benefits_used years_of_payrolls_used
+0    DE           Last 3 years           Last 3 years
+1    OK           Last 3 years           Last 3 years
+```
+
+An instance of `ui_qas` looks like
+
 
 ### Data Fields