crypticorn 2.6.0__py3-none-any.whl → 2.7.0__py3-none-any.whl

crypticorn/common/errors.py

@@ -60,6 +60,7 @@ class ApiErrorIdentifier(ExcludeEnumMixin, StrEnum):
     INVALID_PARAMETER = "invalid_parameter_provided"
     LEVERAGE_EXCEEDED = "leverage_limit_exceeded"
     LIQUIDATION_PRICE_VIOLATION = "order_violates_liquidation_price_constraints"
+    MODEL_NAME_NOT_UNIQUE = "model_name_not_unique"
     NO_CREDENTIALS = "no_credentials"
     NOW_API_DOWN = "now_api_down"
     OBJECT_ALREADY_EXISTS = "object_already_exists"
@@ -318,6 +319,11 @@ class ApiError(ExcludeEnumMixin, Enum, metaclass=ApiErrorFallback):
         ApiErrorType.SERVER_ERROR,
         ApiErrorLevel.ERROR,
     )
+    MODEL_NAME_NOT_UNIQUE = (
+        ApiErrorIdentifier.MODEL_NAME_NOT_UNIQUE,
+        ApiErrorType.USER_ERROR,
+        ApiErrorLevel.ERROR,
+    )
     NO_CREDENTIALS = (
         ApiErrorIdentifier.NO_CREDENTIALS,
         ApiErrorType.USER_ERROR,
@@ -598,6 +604,10 @@ class StatusCodeMapper:
             status.HTTP_409_CONFLICT,
             status.WS_1008_POLICY_VIOLATION,
         ),
+        ApiError.MODEL_NAME_NOT_UNIQUE: (
+            status.HTTP_409_CONFLICT,
+            status.WS_1008_POLICY_VIOLATION,
+        ),
         # Invalid Content
         ApiError.CONTENT_TYPE_ERROR: (
             status.HTTP_415_UNSUPPORTED_MEDIA_TYPE,

crypticorn/hive/client/api/data_api.py

@@ -48,9 +48,10 @@ class DataApi:
         version: Annotated[
             Optional[DataVersion],
             Field(description="Data version. Default is the latest public version."),
-        ],
+        ] = None,
         feature_size: Annotated[
-            Optional[FeatureSize], Field(description="Feature size")
+            Optional[FeatureSize],
+            Field(description="The number of features in the data. Default is LARGE."),
         ] = None,
         _request_timeout: Union[
             None,
@@ -70,9 +71,9 @@ class DataApi:
 
         :param model_id: Model ID (required)
         :type model_id: int
-        :param version: Data version. Default is the latest public version. (required)
+        :param version: Data version. Default is the latest public version.
         :type version: DataVersion
-        :param feature_size: Feature size
+        :param feature_size: The number of features in the data. Default is LARGE.
         :type feature_size: FeatureSize
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -125,9 +126,10 @@ class DataApi:
         version: Annotated[
             Optional[DataVersion],
             Field(description="Data version. Default is the latest public version."),
-        ],
+        ] = None,
         feature_size: Annotated[
-            Optional[FeatureSize], Field(description="Feature size")
+            Optional[FeatureSize],
+            Field(description="The number of features in the data. Default is LARGE."),
         ] = None,
         _request_timeout: Union[
             None,
@@ -147,9 +149,9 @@ class DataApi:
 
         :param model_id: Model ID (required)
         :type model_id: int
-        :param version: Data version. Default is the latest public version. (required)
+        :param version: Data version. Default is the latest public version.
         :type version: DataVersion
-        :param feature_size: Feature size
+        :param feature_size: The number of features in the data. Default is LARGE.
         :type feature_size: FeatureSize
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -202,9 +204,10 @@ class DataApi:
         version: Annotated[
             Optional[DataVersion],
             Field(description="Data version. Default is the latest public version."),
-        ],
+        ] = None,
         feature_size: Annotated[
-            Optional[FeatureSize], Field(description="Feature size")
+            Optional[FeatureSize],
+            Field(description="The number of features in the data. Default is LARGE."),
         ] = None,
         _request_timeout: Union[
             None,
@@ -224,9 +227,9 @@ class DataApi:
 
         :param model_id: Model ID (required)
         :type model_id: int
-        :param version: Data version. Default is the latest public version. (required)
+        :param version: Data version. Default is the latest public version.
         :type version: DataVersion
-        :param feature_size: Feature size
+        :param feature_size: The number of features in the data. Default is LARGE.
         :type feature_size: FeatureSize
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

crypticorn/hive/main.py

@@ -1,3 +1,6 @@
+import asyncio
+from pathlib import Path
+import os
 from crypticorn.hive import (
     ApiClient,
     Configuration,
@@ -6,7 +9,45 @@ from crypticorn.hive import (
     StatusApi,
     Configuration,
 )
-from crypticorn.common import apikey_header as aph
+from crypticorn.hive.utils import download_file
+import logging
+
+
+class DataApiWrapper(DataApi):
+    """
+    A wrapper for the DataApi class.
+    """
+
+    async def download_data(self, folder: Path = "data", *args, **kwargs) -> list[Path]:
+        """
+        Download data for model training. All three files (y_train, x_test, x_train) are downloaded and saved under e.g. FOLDER/v1/coin_1/*.feather.
+        The folder will be created if it doesn't exist.
+
+        :param model_id: Model ID (required) (type: int)
+        :param version: Data version. Default is the latest public version. (optional) (type: DataVersion)
+        :param feature_size: The number of features in the data. Default is LARGE. (optional) (type: FeatureSize)
+        :return: A list of paths to the downloaded files.
+        """
+        response = await super().download_data(*args, **kwargs)
+        base_path = f"{folder}/v{response.version.value}/coin_{response.coin.value}/"
+        os.makedirs(base_path, exist_ok=True)
+
+        return await asyncio.gather(
+            *[
+                download_file(
+                    url=response.links.y_train,
+                    dest_path=base_path + "y_train_" + response.target + ".feather",
+                ),
+                download_file(
+                    url=response.links.x_test,
+                    dest_path=base_path + "x_test_" + response.feature_size + ".feather",
+                ),
+                download_file(
+                    url=response.links.x_train,
+                    dest_path=base_path + "x_train_" + response.feature_size + ".feather",
+                ),
+            ]
+        )
 
 
 class HiveClient:
@@ -24,5 +65,5 @@ class HiveClient:
         self.base_client = ApiClient(configuration=self.config)
         # Instantiate all the endpoint clients
         self.models = ModelsApi(self.base_client)
-        self.data = DataApi(self.base_client)
+        self.data = DataApiWrapper(self.base_client)
         self.status = StatusApi(self.base_client)

crypticorn/hive/utils.py

@@ -0,0 +1,65 @@
+import requests
+import os
+import tqdm
+import logging
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
+
+
+async def download_file(url: str, dest_path: str, show_progress_bars: bool = True) -> str:
+    """downloads a file and shows a progress bar. allow resuming a download"""
+    file_size = 0
+    req = requests.get(url, stream=True, timeout=600)
+    req.raise_for_status()
+
+    total_size = int(req.headers.get("content-length", 0))
+    temp_path = dest_path + ".temp"
+
+    if os.path.exists(dest_path):
+        logger.info(f" file already exists: {dest_path}")
+        file_size = os.stat(dest_path).st_size
+        if file_size == total_size:
+            return dest_path
+
+    if os.path.exists(temp_path):
+        file_size = os.stat(temp_path).st_size
+
+        if file_size < total_size:
+            # Download incomplete
+            logger.info(f" resuming download")
+            resume_header = {"Range": f"bytes={file_size}-"}
+            req = requests.get(
+                url,
+                headers=resume_header,
+                stream=True,
+                verify=False,
+                allow_redirects=True,
+                timeout=600,
+            )
+        else:
+            # Error, delete file and restart download
+            logger.error(f" deleting file {dest_path} and restarting")
+            os.remove(temp_path)
+            file_size = 0
+    else:
+        # File does not exist, starting download
+        logger.info(f" starting download")
+
+    # write dataset to file and show progress bar
+    pbar = tqdm.tqdm(
+        total=total_size,
+        unit="B",
+        unit_scale=True,
+        desc=dest_path,
+        disable=not show_progress_bars,
+    )
+    # Update progress bar to reflect how much of the file is already downloaded
+    pbar.update(file_size)
+    with open(temp_path, "ab") as dest_file:
+        for chunk in req.iter_content(1024):
+            dest_file.write(chunk)
+            pbar.update(1024)
+    # move temp file to target destination
+    os.replace(temp_path, dest_path)
+    return dest_path

{crypticorn-2.6.0.dist-info → crypticorn-2.7.0.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.6.0
-Summary: Maximise Your Crypto Trading Profits with AI Predictions
+Version: 2.7.0
+Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 Project-URL: Homepage, https://crypticorn.com
 Keywords: machine learning,data science,crypto,modelling

{crypticorn-2.6.0.dist-info → crypticorn-2.7.0.dist-info}/RECORD

@@ -64,7 +64,7 @@ crypticorn/common/__init__.py,sha256=42ajAXlz0LDBb1AFyX8xvwpp1MB_YrvqutFDkLthUQM
 crypticorn/common/auth.py,sha256=60SRXlW72VJO8rGzCiemWmzGu8tXDqWr0wt9EM6p8aI,8631
 crypticorn/common/decorators.py,sha256=pmnGYCIrLv59wZkDbvPyK9NJmgPJWW74LXTdIWSjOkY,1063
 crypticorn/common/enums.py,sha256=RitDVqlG_HTe6tHT6bWusZNFCeYk1eQvJVH-7x3_Zlg,668
-crypticorn/common/errors.py,sha256=I1wuD8ZaMqlhJDk-SE1yS41KyjPEhNQ4r4LpLXwcSBw,27515
+crypticorn/common/errors.py,sha256=K1VSEKZro1I4cmi-sOhx24pTrvhbbD4RBRRqKodWpA8,27851
 crypticorn/common/exceptions.py,sha256=Rrpk2ORou2F__cNUWmXs6tFZwIFBZppF4YapUSZLfOQ,5662
 crypticorn/common/mixins.py,sha256=LKPcNTR8uREeDGWTlWozNx7rS1mYdQVx1RllLhxIAsE,1640
 crypticorn/common/pagination.py,sha256=c07jrMNrBaNTmgx4sppdP7ND4RNT7NBqBXWvofazIlE,2251
@@ -73,7 +73,8 @@ crypticorn/common/status_router.py,sha256=s7LY3aNQPhtDUgNWHRszfCQMl0Uh13li_jR8je
 crypticorn/common/urls.py,sha256=3Gf1NU1XQYcOTjcdztG3bDAE98FVbgTK2QXzUe7tFVQ,878
 crypticorn/common/utils.py,sha256=Kz2-I96MKIGKM18PHQ77VbKHLMGUvZG_jjj7xpQed8k,2138
 crypticorn/hive/__init__.py,sha256=hRfTlEzEql4msytdUC_04vfaHzVKG5CGZle1M-9QFgY,81
-crypticorn/hive/main.py,sha256=WUgsjs9p9zZ5NgPuD54m1u8dLnM8yaYCYHF51AH2IaE,665
+crypticorn/hive/main.py,sha256=8-MKEE9zjxjSk4QMD-PcezD5MS-A1BzCFAmdgunJqyg,2308
+crypticorn/hive/utils.py,sha256=nQe_GLb2Xk9EsuYpHASb_Sik5VyNXEHewCgT1LN4woo,2060
 crypticorn/hive/client/__init__.py,sha256=BZ7MlUhK1x5j73WRPTPJFbTSELv9urdbpPonq04m6Aw,2331
 crypticorn/hive/client/api_client.py,sha256=fDFsACK7hxXw_sgt3ZJVH2RplEdUhR0YZd4tsZA9P5Q,26869
 crypticorn/hive/client/api_response.py,sha256=WhxwYDSMm6wPixp9CegO8dJzjFxDz3JF1yCq9s0ZqKE,639
@@ -82,7 +83,7 @@ crypticorn/hive/client/exceptions.py,sha256=IKuM8sbMtr3T9z-fOuePTJmheUFahzmyZ8ia
 crypticorn/hive/client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 crypticorn/hive/client/rest.py,sha256=VhXkE7R3y1RD0QmbvIwmsk-LP_DmOei_zd9YiIXer28,6975
 crypticorn/hive/client/api/__init__.py,sha256=y0KYdyqWZTjlf6IKASYmLdUs9a2aiFMHrfQO_V_-ZUw,223
-crypticorn/hive/client/api/data_api.py,sha256=9WpN0R1eI6Bq7KfJwm7R_fJ0IYIDoBIehQiUG3sb4kE,22351
+crypticorn/hive/client/api/data_api.py,sha256=GJlH2Qs1KmWCc4nv7y5byyyFDiidLdooG-WvbBv-Z-4,22624
 crypticorn/hive/client/api/models_api.py,sha256=61r9uObh1puEGJOXi_v-LmEP1xNqfbEo5spEYzlAA44,74136
 crypticorn/hive/client/api/status_api.py,sha256=3ZZ9e1duL9Oz8gWvQQMryUevuRY_ERMPpClW8gY2THE,28714
 crypticorn/hive/client/models/__init__.py,sha256=C-SmdIMEQljgJaxgADRAgHQuknh0sCZiAELnHC4SuJI,1539
@@ -220,8 +221,8 @@ crypticorn/trade/client/models/strategy_model_input.py,sha256=ala19jARyfA5ysys5D
 crypticorn/trade/client/models/strategy_model_output.py,sha256=2o2lhbgUSTznowpMLEHF1Ex9TG9oRmzlCIb-gXqo7_s,5643
 crypticorn/trade/client/models/tpsl.py,sha256=C2KgTIZs-a8W4msdaXgBKJcwtA-o5wR4rBauRP-iQxU,4317
 crypticorn/trade/client/models/trading_action_type.py,sha256=pGq_TFLMPfYFizYP-xKgEC1ZF4U3lGdJYoGa_ZH2x-Q,769
-crypticorn-2.6.0.dist-info/METADATA,sha256=bDu5aD7J0MfUC_bMe6FL57Z8niFcOTBWWG_WTu1tEro,6247
-crypticorn-2.6.0.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
-crypticorn-2.6.0.dist-info/entry_points.txt,sha256=d_xHsGvUTebPveVUK0SrpDFQ5ZRSjlI7lNCc11sn2PM,59
-crypticorn-2.6.0.dist-info/top_level.txt,sha256=EP3NY216qIBYfmvGl0L2Zc9ItP0DjGSkiYqd9xJwGcM,11
-crypticorn-2.6.0.dist-info/RECORD,,
+crypticorn-2.7.0.dist-info/METADATA,sha256=WcIXa2urQyx79i-xY-v6Q6TicA9zaybXWNOcmg2euxo,6249
+crypticorn-2.7.0.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
+crypticorn-2.7.0.dist-info/entry_points.txt,sha256=d_xHsGvUTebPveVUK0SrpDFQ5ZRSjlI7lNCc11sn2PM,59
+crypticorn-2.7.0.dist-info/top_level.txt,sha256=EP3NY216qIBYfmvGl0L2Zc9ItP0DjGSkiYqd9xJwGcM,11
+crypticorn-2.7.0.dist-info/RECORD,,