v0.3.0

[AzulGarza]

What's Changed

Changelog

0.3.0

🔄 Changes & Deprecations

• Deprecation of TimeGPT Class:
  In an effort to streamline our API and align with industry best practices, we're deprecating the TimeGPT class in favor of the new NixtlaClient class. This change is designed to provide a more intuitive and powerful interface for interacting with our services.

  Before:

  from nixtlats import TimeGPT
  
  # Initialize the TimeGPT model
  timegpt = TimeGPT()

  After:

  from nixtlats import NixtlaClient
  
  # Initialize the NixtlaClient
  nixtla = NixtlaClient()

• Renaming of Configuration Parameters:
  To enhance clarity and consistency with other SDKs, we've renamed the token parameter to api_key and environment to base_url.

  Before:

  timegpt = TimeGPT(token='YOUR_TOKEN', environment='YOUR_ENVIRONMENT_URL')

  After:

  nixtla = NixtlaClient(api_key='YOUR_API_KEY', base_url='YOUR_BASE_URL')

• Introduction of NixtlaClient.validate_api_key:
  Replacing the previous NixtlaClient.validate_token method, this update aligns with the new authentication parameter naming and offers a straightforward way to validate API keys.

  Before:

  timegpt.validate_token()

  After:

  nixtla.validate_api_key()

• Environment Variable Changes:
  In line with the renaming of parameters, we've updated the environment variables to set up the API key and base URL. The TIMEGPT_TOKEN is now replaced with NIXTLA_API_KEY, and we've introduced NIXTLA_BASE_URL for custom API URLs.

• Backward Compatibility & Future Warnings:
  These changes are designed to be backward compatible. However, users can expect to see future warnings when utilizing deprecated features, such as the TimeGPT class.

0.2.0 (Previously Released)

🔄 Changes & Deprecations

• Renaming of Fine-Tuning Parameters:
  The finetune_steps and finetune_loss parameters were renamed to fewshot_steps and fewshot_loss. Additionally, the model parameter values changed from short-horizon and long-horizon to timegpt-1 and timegpt-1-long-horizon, with an emphasis on preserving backward compatibility. In version 0.3.0, these changes are deprecated in favor of reverting to the original parameter names and values, ensuring a seamless transition for existing users.

Features

• feat: update docs in Hotfix/tutorial update #268
• feat: add moirai benchmark in feat: add moirai benchmark #271
• feat: replace token by api_key and environment by base_url in feat: replace token by api_key and environment by base_url #275
• feat: replace TimeGPT class by NixtlaClient class in feat: replace TimeGPT class by NixtlaClient class #276

Fixes

• fix: recover finetune and model changes in fix: recover finetune and model changes #274
• fix nixtla_client page render in fix nixtla_client page render #279

Full Changelog: v0.2.0...v0.3.0

---

This discussion was created from the release v0.3.0.