Update README.md

README.md

@@ -13,132 +13,109 @@ JobStreet Job Postings Dataset
 
 ### Dataset Description
 
-<!-- Provide a longer summary of what this dataset is. -->
-This dataset compiles a huge range of job listings from Jobstreet, offering a comprehensive view of the current employment landscape from various industries in Malaysia specifically. The dataset includes key features such as unique job IDs, titles, company names, locations, job roles, categories, subcategories, job types, salaries, and detailed descriptions. My motivation in creating and sharing this dataset is to provide actionable insights for researchers, job seekers, and organizations.
+This dataset compiles a comprehensive range of job listings from JobStreet, offering a detailed view of the current employment landscape across various industries in Malaysia. It includes key features such as unique job IDs, titles, company names, locations, job roles, categories, subcategories, job types, salaries, and detailed descriptions. The motivation behind creating and sharing this dataset is to provide actionable insights for researchers, job seekers, and organizations interested in understanding job market trends and dynamics.
 
 The data is scheduled to be updated weekly from the output of a web scraping script.
 
+- **Curated by:** [Azrai Mahadan]
+- **Funded by:** [Optional Funding Source]
+- **Shared by:** [Optional Sharing Source]
+- **Language(s) (NLP):** English
+- **License:** Creative Commons Attribution 4.0 International (CC BY 4.0)
 
-- **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 
 
-### Dataset Sources [optional]
+- **Repository:** [JobStreet Job Postings Dataset](https://huggingface.co/datasets/azrai99/job-dataset)
 
-<!-- Provide the basic links for the dataset. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
 
 ## 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]
+This dataset is suitable for various applications, including:
+- Job market analysis
+- Research on employment trends in Malaysia
+- Machine learning model training for job recommendation systems
+- Business intelligence for companies looking to understand hiring practices
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
-
-[More Information Needed]
+This dataset should not be used for:
+- Malicious applications or purposes that exploit job seekers
+- Applications that require real-time data accuracy, as the dataset is updated weekly
 
 ## 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]
+| Field          | Data Type      | Description                                     |
+|----------------|----------------|-------------------------------------------------|
+| job_id         | int64          | Unique identifier for each job posting          |
+| job_title      | string         | Title of the job position                        |
+| company        | string         | Name of the hiring company                       |
+| descriptions   | string         | Detailed job description                         |
+| location       | string         | Job location                                    |
+| category       | string         | Job category (e.g., Manufacturing, Transport)  |
+| subcategory    | string         | More specific job category                       |
+| role           | string         | Job role                                        |
+| type           | string         | Employment type (e.g., Contract/Temp, Full time)|
+| salary         | string         | Salary information, if available                 |
+| listingDate    | string         | Date when the job was listed                    |
 
 ## Dataset Creation
 
 ### Curation Rationale
 
-<!-- Motivation for the creation of this dataset. -->
-
-[More Information Needed]
+The dataset was created to provide a transparent and accessible source of job postings, aiding in employment research and analysis within Malaysia.
 
 ### 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 was collected through a web scraping script that aggregates job postings from JobStreet. The data is filtered to remove duplicates and irrelevant postings. The fields were normalized for consistency, ensuring standardized formatting across job titles, descriptions, and salary information.
 
 #### Who are the source data producers?
 
-<!-- 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. -->
+The source data is produced by various companies that list job postings on JobStreet, covering multiple sectors and industries in Malaysia.
 
-[More Information Needed]
+### Annotations 
 
-### 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]
+No additional annotations have been made to the dataset at this time.
 
 #### 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]
+The dataset does not contain personally identifiable information (PII) or sensitive data about job applicants.
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+While the dataset aims to be comprehensive, it may not capture every job posting available, leading to potential biases in job market representation. The job listings are also subject to changes based on market demands, which may not be reflected immediately in the dataset.
 
 ### Recommendations
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+Users should be aware of the limitations of the dataset, especially regarding potential biases and the dynamic nature of job postings. It is recommended to use the dataset in conjunction with other sources for a more holistic view of the job market.
 
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
+## Citation 
 
-## 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. -->
+If you use this dataset in your work, please cite it as follows:
 
 **BibTeX:**
 
-[More Information Needed]
-
-**APA:**
+@misc{jobstreet_dataset, title={JobStreet Job Postings Dataset}, author={Mohamad Azrai bin Mahadan}, year={2024}, url={https://huggingface.co/datasets/azrai99/job-dataset} }
 
 [More Information Needed]
 
-## Glossary [optional]
+**APA:**
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
+Mohamad Azrai bin Mahadan(Telekom Malaysia) (2024). *JobStreet Job Postings Dataset*. https://huggingface.co/datasets/azrai99/job-dataset.
 
-[More Information Needed]
 
-## More Information [optional]
+## Glossary 
 
-[More Information Needed]
+- **Job ID**: A unique identifier assigned to each job posting.
+- **Employment Type**: Refers to the nature of the employment contract (e.g., Full-time, Part-time, Contract).
 
-## Dataset Card Authors [optional]
+## More Information 
 
-[More Information Needed]
+For further information about the dataset or inquiries, please contact [email]([email protected]).
 
-## Dataset Card Contact
+## Dataset Card Authors 
 
-[More Information Needed]
+[Mohamad Azrai bin Mahadan (Telekom Malaysia)]