numerapi 2.15.1__tar.gz → 2.16.0__tar.gz

{numerapi-2.15.1 → numerapi-2.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: numerapi
-Version: 2.15.1
+Version: 2.16.0
 Summary: Automatically download and upload data for the Numerai machine learning competition
 Home-page: https://github.com/uuazed/numerapi
 Maintainer: uuazed

{numerapi-2.15.1 → numerapi-2.16.0}/numerapi/base_api.py

@@ -833,7 +833,6 @@ class Api:
                     utils.replace(score, "payoutSettled", fun)
         return performances
 
-
     def round_model_performances(self, username: str) -> List[Dict]:
         """Fetch round model performance of a user.
 
@@ -1427,3 +1426,83 @@ class Api:
             item["name"]: item["id"]
             for item in data["computePickleDockerImages"]}
         return res
+
+    def submission_ids(self, model_id: str):
+        """ Get all submission ids from a model
+
+        Args:
+            model_id (str)
+
+        Returns:
+            list of dicts: list of submissions
+
+            For each entry in the list, there is a dict with the following
+            content:
+
+                * insertedAt (`datetime`)
+                * filename (`str`)
+                * id (`str`)
+
+         Example:
+            >>> api = NumerAPI(secret_key="..", public_id="..")
+            >>> model_id = napi.get_models()["uuazed"]
+            >>> api.submission_ids(model_id)
+        """
+        query = """
+            query($modelId: String) {
+                submissions(modelId: $modelId) {
+                    id
+                    filename
+                    insertedAt
+                }
+            }
+        """
+        raw = self.raw_query(query, {"modelId": model_id}, authorization=True)
+        data = raw["data"]["submissions"]
+        utils.replace(data, "insertedAt", utils.parse_datetime_string)
+        return data
+
+    def download_submission(self, submission_id: str = None,
+                            model_id: str = None, dest_path: str = None) -> str:
+        """ Download previous submissions from numerai
+
+        Args:
+            submission_id (str, optional): the submission to be downloaded
+            model_id (str, optional): if provided, the latest submission of that
+                                      model gets downloaded
+            dest_path (str, optional): where to save the downloaded file
+
+        Returns:
+            str: path to downloaded file
+
+        Example:
+            # fetch latest submission
+            >>> api = NumerAPI(secret_key="..", public_id="..")
+            >>> model_id = napi.get_models()["uuazed"]
+            >>> api.download_submission(model_id=model_id)
+            # fetch older submssion
+            >>> ids = submission_ids(model_id)
+            >>> import random; submission_id = random.choice(ids)["id"]
+            >>> api.download_submission(submission_id=submission_id)
+        """
+        msg = "You need to provide one of `model_id` and `submission_id"
+        assert model_id or submission_id, msg
+        auth_query = '''
+            query($id: String) {
+                submissionDownloadAuth(id: $id) {
+                    filename
+                    url
+                }
+            }
+        '''
+        if not submission_id:
+            ids = self.submission_ids(model_id)
+            submission_id = max(ids, key=lambda x: x['insertedAt'])["id"]
+
+        data = self.raw_query(
+            auth_query, {'id': submission_id},
+            authorization=True)['data']["submissionDownloadAuth"]
+        if dest_path is None:
+            dest_path = data["filename"]
+        path = utils.download_file(data["url"], dest_path)
+        return path

{numerapi-2.15.1 → numerapi-2.16.0}/numerapi/numerapi.py

@@ -71,13 +71,13 @@ class NumerAPI(base_api.Api):
         args = {'round': round_num}
         return self.raw_query(query, args)['data']['listDatasets']
 
-    def download_dataset(self, filename: str = "numerai_live_data.csv",
+    def download_dataset(self, filename: str = None,
                          dest_path: str = None,
                          round_num: int = None) -> None:
         """ Download specified file for the given round.
 
         Args:
-            filename (str): file to be downloaded, defaults to live data
+            filename (str, optional): file to be downloaded
             dest_path (str, optional): complete path where the file should be
                 stored, defaults to the same name as the source file
             round_num (int, optional): tournament round you are interested in.

{numerapi-2.15.1 → numerapi-2.16.0}/numerapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: numerapi
-Version: 2.15.1
+Version: 2.16.0
 Summary: Automatically download and upload data for the Numerai machine learning competition
 Home-page: https://github.com/uuazed/numerapi
 Maintainer: uuazed

{numerapi-2.15.1 → numerapi-2.16.0}/setup.py

@@ -6,7 +6,7 @@ def load(path):
     return open(path, 'r').read()
 
 
-numerapi_version = '2.15.1'
+numerapi_version = '2.16.0'
 
 
 classifiers = [