python api for interacting with crowdAI grading infrastructure
Project description
crowdAI API
python client for server side API of the crowdai.org webapp.
- Free software: GNU General Public License v3
- Documentation: https://crowdai-api.readthedocs.io.
Installation
Deployment
pip install git+https://github.com/crowdAI/crowdai_api.git
Development
git clone https://github.com/crowdAI/crowdai_api
cd crowdai_api
pip install -r requirements_dev.txt
pip install -e .
Usage
Instantiate API object
from crowdai_api import API as CROWDAI_API auth_token="<YOUR CROWDAI AUTH TOKEN>" api = CROWDAI_API(auth_token)
Authenticate participant
- with
API_KEY
api.authenticate_participant(EXAMPLE_API_KEY)
- with
username
api_key = api.authenticate_participant_with_username("spMohanty")
Get all Submissions
challenge_id = "test_challenge" submissions = api.get_all_submissions(challenge_id) print(submissions)
Create Submission
challenge_id = "test_challenge" submission = api.create_submission(challenge_id) print(submission) # Output # ======================================== # CrowdAISubmission : 5261 # challenge_id : test_challenge # round_id : False # score : False # score_secondary : False # grading_status : submitted # message : # ========================================
Get submission
submission_id = 5262 challenge_id = "test_challenge" submission = api.get_submission(challenge_id, submission_id)
Update submission
Assuming you have a submission
object by using api.create_submission
or api.get_submission
.
You can update the submission by :
# Update params submission.grading_status = "graded" submission.score = 0.98 submission.score_secondary = 0.98 submission.update() print(submission) # Output# # ======================================== # CrowdAISubmission : 5262 # challenge_id : test_challenge # round_id : False # score : 0.98 # score_secondary : 0.98 # grading_status : graded # message : # ========================================
Tests
# Setup the environment varriables cp environ.sh.example environ.sh # Then modify the respective environment variables source environ.sh pytests tests/
Author
S.P.Mohanty sharada.mohanty@epfl.ch
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
crowdai_api-0.1.22.tar.gz
(9.2 kB
view hashes)