Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dataset Scripts & Docs #1

Merged
merged 4 commits into from
Feb 1, 2021
Merged

Dataset Scripts & Docs #1

merged 4 commits into from
Feb 1, 2021

Conversation

elatoskinas
Copy link
Collaborator

Added scripts from ml-typeinf-competition with an updated readme

README.md Outdated
## Dataset preparation
**Pre-requisites:**
* Python dependencies from `scripts/requirements.txt` installed (run `pip install -r scripts/requirements.txt`)
* A repositories folder (dataset), where git projects are stored in format `[dataset path]/author/repo`
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have a script we can add for cloning all repos from a spec file? :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@elatoskinas
yes, it's here: https://github.com/saltudelft/many-types-4-py-dataset/blob/master/repo_cloner/__main__.py
The first step is to run the cloner with this JSON file as input: https://github.com/saltudelft/many-types-4-py-dataset/blob/master/mypy-dependents-by-stars.json

The second step is to write a shell script that changes the state of git repositories based on the commit hash.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushed the update, I've documented how to run the cloner with the given json file, and added an auxiliary script in the scripts folder in order to revert the commit hashes.

@mir-am
Copy link
Member

mir-am commented Jan 29, 2021

@elatoskinas
I'll revise the README file a bit and then merge it.

@elatoskinas
Copy link
Collaborator Author

@mir-am I've just realized this is missing our JSON representation generation (and also the process_dataset.sh does not have this added in). How do you recon we add this in?

@mir-am
Copy link
Member

mir-am commented Feb 1, 2021

@mir-am I've just realized this is missing our JSON representation generation (and also the process_dataset.sh does not have this added in). How do you recon we add this in?

I'll add the JSON representation step to the README. Before that, I need to add setup.py file for LibSA4Py package.

@mir-am mir-am self-assigned this Feb 1, 2021
@mir-am
Copy link
Member

mir-am commented Feb 1, 2021

@elatoskinas
I'm gonna merge this PR for now. It'd be great if you could update prepare_dataset.sh script to include all the steps that are documented in README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants