class_docstr: Abstract base class for custom runner classes
class_docstr_tok: ["Abstract","base","class","for","custom","runner","classes"]
docstr: Checks how much available capacity there is to schedule trial evaluations.
  Required for runners used with Ax ``Scheduler``.
  
  NOTE: This method might be difficult to implement in some systems. Returns -1
  if capacity of the system is "unlimited" or "unknown"
  (meaning that the ``Scheduler`` should be trying to schedule as many trials
  as is possible without violating scheduler settings). There is no need to
  artificially force this method to limit capacity; ``Scheduler`` has other
  limitations in place to limit number of trials running at once,
  like the ``SchedulerOptions.max_pending_trials`` setting, or
  more granular control in the form of the `max_parallelism`
  setting in each of the `GenerationStep`s of a `GenerationStrategy`).
  
  Returns:
      An integer, representing how many trials there is available capacity for;
      -1 if capacity is "unlimited" or not possible to know in advance.
docstr_tok: ["Checks","how","much","available","capacity","there","is","to","schedule","trial","evaluations",".","Required","for","runners","used","with","Ax","``","Scheduler","``",".","NOTE",":","This","method","might","be","difficult","to","implement","in","some","systems",".","Returns","-1","if","capacity","of","the","system","is","``","unlimited","''","or","``","unknown","''","(","meaning","that","the","``","Scheduler","``","should","be","trying","to","schedule","as","many","trials","as","is","possible","without","violating","scheduler","settings",")",".","There","is","no","need","to","artificially","force","this","method","to","limit","capacity",";","``","Scheduler","``","has","other","limitations","in","place","to","limit","number","of","trials","running","at","once",",","like","the","``","SchedulerOptions.max_pending_trials","``","setting",",","or","more","granular","control","in","the","form","of","the","`","max_parallelism","`","setting","in","each","of","the","`","GenerationStep","`","s","of","a","`","GenerationStrategy","`",")",".","Returns",":","An","integer",",","representing","how","many","trials","there","is","available","capacity","for",";","-1","if","capacity","is","``","unlimited","''","or","not","possible","to","know","in","advance","."]
code: def poll_available_capacity(self) -> int:
      """Checks how much available capacity there is to schedule trial evaluations.
      Required for runners used with Ax ``Scheduler``.
  
      NOTE: This method might be difficult to implement in some systems. Returns -1
      if capacity of the system is "unlimited" or "unknown"
      (meaning that the ``Scheduler`` should be trying to schedule as many trials
      as is possible without violating scheduler settings). There is no need to
      artificially force this method to limit capacity; ``Scheduler`` has other
      limitations in place to limit number of trials running at once,
      like the ``SchedulerOptions.max_pending_trials`` setting, or
      more granular control in the form of the `max_parallelism`
      setting in each of the `GenerationStep`s of a `GenerationStrategy`).
  
      Returns:
          An integer, representing how many trials there is available capacity for;
          -1 if capacity is "unlimited" or not possible to know in advance.
      """
      return -1
  
file_path: Ax/ax/core/runner.py
imports: from __future__ import annotations
  from abc import ABC, abstractmethod
  from typing import Any, Dict, Iterable, List, Optional, Set, TYPE_CHECKING
  from ax.utils.common.base import Base
  from ax.utils.common.serialization import SerializationMixin
label_desc: Use image node_id 5 for calling the Runner obj's underlying member method code with example usage: obj.poll_available_capacity() and returns: unknown