Update README.md

README.md

@@ -54,139 +54,99 @@ tags:
 - EDGAR
 - filings
 ---
-# Dataset Card for Dataset Name
-
-Metadata for all submissions to the Securities and Exchange Commission from 1994 (start) until December 14, 2024. Extracted from quarterly master files. 
-
+# Dataset Card for SEC EDGAR Filings Master Index
 
 ## Dataset Details
 
 ### Dataset Description
 
-<!-- Provide a longer summary of what this dataset is. -->
-
-
-
-- **Curated by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-
-### Dataset Sources [optional]
+This dataset contains metadata for all submissions to the Securities and Exchange Commission (SEC) through their EDGAR system from 1994 until December 14, 2024. The data is extracted from quarterly master files and includes key information about company filings such as CIK numbers, company names, form types, and filing dates.
 
-<!-- Provide the basic links for the dataset. -->
+- **Curated by:** Arthur (arthur@cicero.chat)
+- **Language(s):** English
+- **License:** Likely public domain as US government data
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+### Dataset Sources
+- **Repository:** Based on SEC EDGAR database
+- **Primary Source:** SEC EDGAR system (https://www.sec.gov/edgar.shtml)
 
 ## Uses
 
-<!-- Address questions around how the dataset is intended to be used. -->
-
 ### Direct Use
-
-<!-- This section describes suitable use cases for the dataset. -->
-
-[More Information Needed]
+- Financial research and analysis
+- Corporate compliance monitoring
+- Historical filing pattern analysis
+- Company information retrieval
+- Regulatory filing tracking
+- Market research and analytics
 
 ### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
-
-[More Information Needed]
+- Real-time filing monitoring (dataset is historical)
+- Analysis of filing content (contains only metadata)
+- Legal advice or compliance determinations
+- Personal identification or contact information gathering
 
 ## Dataset Structure
 
-<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
-
-[More Information Needed]
+The dataset contains the following fields:
+
+1. **_id**: Unique identifier (36 characters)
+2. **timestamp**: Timestamp of record creation
+3. **cik**: Company Identifier (1-7 digits)
+4. **company_name**: Name of filing company (0-150 characters)
+5. **form_type**: Type of SEC form filed (734 distinct values)
+6. **date_filed**: Date of filing submission
+7. **filename**: Path to filing in EDGAR system (37-43 characters)
+8. **url**: Direct link to filing (66-72 characters)
+9. **quarter**: Filing quarter (1-4)
+10. **year**: Filing year (1994-2024)
+11. **master_metadata**: Dictionary containing:
+    - Description
+    - Last Data Received
+    - Comments
+    - Anonymous FTP
+    - Cloud HTTP
+12. **idx_type**: Filing index type
 
 ## Dataset Creation
 
 ### Curation Rationale
-
-<!-- Motivation for the creation of this dataset. -->
-
-[More Information Needed]
+The dataset was created to provide a comprehensive index of all SEC EDGAR filings, enabling research, analysis, and monitoring of corporate financial disclosures and regulatory compliance.
 
 ### Source Data
 
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
-
 #### Data Collection and Processing
-
-<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
-
-[More Information Needed]
+- Data is collected from SEC EDGAR quarterly master files
+- Processing includes structuring the data into a consistent format
+- URLs are standardized to SEC.gov domain
+- Timestamps are standardized to a consistent format
+- Unique identifiers are assigned to each record
 
 #### Who are the source data producers?
+- Primary data producers are publicly traded companies and other entities required to file with the SEC
+- Data is collected and distributed by the U.S. Securities and Exchange Commission
 
-<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
-
-[More Information Needed]
-
-### Annotations [optional]
-
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
-
-#### Annotation process
-
-<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
-
-[More Information Needed]
-
-#### Who are the annotators?
-
-<!-- This section describes the people or systems who created the annotations. -->
-
-[More Information Needed]
-
-#### Personal and Sensitive Information
-
-<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
-
-[More Information Needed]
+### Personal and Sensitive Information
+The dataset contains only publicly available information from SEC filings. While it includes company names and identifiers, it does not contain personal information beyond what is already public in SEC filings.
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+- Historical data may be incomplete for earlier years
+- Company names may change over time
+- CIK numbers may be reused in rare cases
+- Form types may be deprecated or changed over time
+- URLs may become invalid if SEC changes its archive structure
+- Coverage limited to SEC-regulated entities
 
 ### Recommendations
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Dataset Card Authors [optional]
-
-[More Information Needed]
+- Verify current company information through SEC's current EDGAR system
+- Cross-reference CIK numbers when tracking companies over time
+- Consider form type changes when analyzing historical patterns
+- Implement appropriate error handling for URL access
+- Use appropriate date ranges for analysis based on regulation changes
+- Consider regulatory context when analyzing filing patterns
 
 ## Dataset Card Contact
 
-[More Information Needed]
+Arthur ([email protected])