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

docs with example? #152

Open
hcientist opened this issue Nov 17, 2019 · 2 comments
Open

docs with example? #152

hcientist opened this issue Nov 17, 2019 · 2 comments

Comments

@hcientist
Copy link

I can see that there's some description of the individual data sets on their respective web pages (e.g. https://think.cs.vt.edu/corgis/blockpy/food_access/ ), but is there doc that shows the api of these modules? dir wasn't as illuminating as I'd hoped...

@acbart
Copy link
Contributor

acbart commented Nov 17, 2019

Just a head's up, we've been transitioning to a new repo: https://github.com/corgis-edu/corgis

Are you using the BlockPy dataset, or the Python dataset? If you check the Python version, you can see the API more clearly: https://think.cs.vt.edu/corgis/python/food_access/

If you're using the BlockPy side, then it's expected that you'd use the Blocks to access the datasets (obviating the textual API). The code shown in the Python version works in BlockPy too, although there's an additional API function that's not supported in the Python mode (since it trivializes some of our assignments to support too convenient filtering).

@hcientist
Copy link
Author

Awesome, thanks. That gets me rolling, I'll leave it to y'all to decide if you want this to remain open to remind you to document, but perhaps you don't need to given that python api page.

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

No branches or pull requests

2 participants