Skip to main content

numin package

Project description

numin2 Package

numin2 is a Python package designed for algorithmic trading and backtesting providing an API called Numin2API.

numin (v1) is a different package!!

numin2 is under development; features available are documented below

Features

  • Data Retrieval: Download training, round, and validation data.
  • Prediction Submission: TBD
  • Real-Time Round Management: TBD
  • Backtesting: Backtesting cross-sectional predictions vs targets for Nifty50
  • File Management: TBD
  • Returns Summary: TBD

Supported Methods

  • Data Download:

    • Numin2API().get_data_for_month(self,year,month,batch_size=4,window_size=100,target_type='rank'):

    • Returns batches of sequences (lists) for the given year and month of Nifty 50 or n returns

    • Dimension of each sequence is window,n. Returns NuminDataset of shape batch_size,window_size,n for features. Default n=50. (Later n will be a parameter).

    • Targets are next day returns / ranked returns of shape batch_size,n

    • Numin2API().download_data(outfile,type='daily',features='returns')

    • Download data for a given type and features

    • type can be 'daily','intraday'

    • features can be 'returns' (close returns),'open_close' (open-close returns), or 'ohlcv'

    • outfile is the name of the parquet file to save the data

    • get_range_dataloader(data_path: str, start_year: int, start_month: int, end_year: int, end_month: int, batch_size: int = 32, window_size: int = 100, target_type: str = 'raw', top_k: int = 10)

    • Returns a torch dataloader for the given range of years and months of Nifty 50 or n returns

    • Dimension of each day is window,n. Returns tensor of shape batch_size,window_size,n for features. Default n=50. (Later n will be a parameter).

    • Targets are next day returns / ranked returns of shape batch_size,n

    • get_dataloader(data_path: str, batch_size: int = 32, window_size: int = 100, target_type: str = 'raw', top_k: int = 10)

    • Returns a torch dataloader for the given range of years and months of Nifty 50 or n returns

    • Dimension of each day is window,n. Returns tensor of shape batch_size,window_size,n for features. Default n=50. (Later n will be a parameter).

    • Targets are next day returns / ranked returns of shape batch_size,n

    • Numin2API()fetch_intraday_raw_data(delta=50,features='returns')

    • fetches current intraday data given delta time in minutes before current time

    • returns dataframe that can be appended to the consolidated data file or used in memory

    • features can be returns or ohlcv

  • Backytesting

    • backtest_positions(positions,targets,txn_costs=.9)
    • Taks a batch of positions for 50 stocks
    • Each position is a list of length 50, 0, 1, -1 values only.
    • Targets are returns (real numbers) for each of these stocks ove the batch.
    • Returns a dict such as {'daily_pnl','total_profit','sharpe_ratio,'mean_daily_return'}

Installation

Install numin2 using pip:

pip install numin2

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

numin2-1.0.8.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

numin2-1.0.8-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file numin2-1.0.8.tar.gz.

File metadata

  • Download URL: numin2-1.0.8.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.14

File hashes

Hashes for numin2-1.0.8.tar.gz
Algorithm Hash digest
SHA256 5d0f02a4692263ca27085bc7a97b907bd159be84f6f09b3cb7c2e6c53ba364a0
MD5 cf3f798c03323a5505b09b3fdedc853b
BLAKE2b-256 ab4bf7d9865da30b67800897a33c7f40f23dc99d6886fc912e5a2cfcc954bfd4

See more details on using hashes here.

File details

Details for the file numin2-1.0.8-py3-none-any.whl.

File metadata

  • Download URL: numin2-1.0.8-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.14

File hashes

Hashes for numin2-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 9138655d99dab92b4f3c7f7f20bb8a07c0adb1ba9c5f31b1bf245dcd6059ce89
MD5 3c0c47177a847c6217ba7c735ed67bac
BLAKE2b-256 a8159c3061f099e08b08fd1bb0b2d89d373efe6db53088cddd208c69e6ca8f40

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page