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)
    • backtest_positions(positions,targets,txn_costs=.1)
    • Takes a batch of positions for 50 stocks
    • Each position is a list of length 51, 0 position for cash, rest interpreted as weight with which capital is allocated. So 1 0 0 0 .. means no positions all cash. Sum must be non-zero.
    • 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'}
  • News Data

    • get_news(datestr), get_all_news_dates()
    • Unstructured news data is available for historical and current dates; datestr in the format 10-03-2026 to be passed

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.11.tar.gz (14.3 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.11-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: numin2-1.0.11.tar.gz
  • Upload date:
  • Size: 14.3 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.11.tar.gz
Algorithm Hash digest
SHA256 c242912e8f8aaac039bd52bb22ea03c7b5397c0d1462e97d824cd89bb16b7bbb
MD5 b297cb0b69a54419b5b1e1317f9370cd
BLAKE2b-256 8e243475cbe93166d58b0f20a3d4dada4780f417924bd9068aa7293fed2ccf1e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: numin2-1.0.11-py3-none-any.whl
  • Upload date:
  • Size: 14.2 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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 f6351644669f72e64d9e6651f39deda6cff06ad470c19e598b017b7358c4908c
MD5 8eb729349eef3aca358b03a3b4f1dc68
BLAKE2b-256 ba04b91fa91722a8ae76f1568164e31e8d5982e101b956cdd5d6ad27a1a54e76

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