Skip to content
Clustrix
menu
Docs
Index
JavaScript is required to toggle light/dark mode..
Light mode
Dark mode
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
|
V
_
__del__() (clustrix.file_packaging.FilePackager method)
,
[1]
(clustrix.filesystem.ClusterFilesystem method)
,
[1]
__enter__() (clustrix.local_executor.LocalExecutor method)
__eq__() (clustrix.filesystem.DiskUsage method)
,
[1]
(clustrix.filesystem.FileInfo method)
,
[1]
__exit__() (clustrix.local_executor.LocalExecutor method)
__init__() (clustrix.config.ClusterConfig method)
(clustrix.cost_monitoring.BaseCostMonitor method)
(clustrix.cost_monitoring.CostEstimate method)
(clustrix.cost_monitoring.CostReport method)
(clustrix.cost_monitoring.ResourceUsage method)
(clustrix.cost_providers.aws.AWSCostMonitor method)
(clustrix.cost_providers.azure.AzureCostMonitor method)
(clustrix.cost_providers.gcp.GCPCostMonitor method)
(clustrix.cost_providers.lambda_cloud.LambdaCostMonitor method)
(clustrix.dependency_analysis.DependencyAnalyzer method)
,
[1]
(clustrix.dependency_analysis.DependencyGraph method)
,
[1]
(clustrix.dependency_analysis.FileReference method)
,
[1]
(clustrix.dependency_analysis.FilesystemCall method)
,
[1]
(clustrix.dependency_analysis.ImportInfo method)
,
[1]
(clustrix.dependency_analysis.LocalFunctionCall method)
,
[1]
(clustrix.dependency_analysis.LoopAnalyzer method)
,
[1]
(clustrix.file_packaging.ExecutionContext method)
,
[1]
(clustrix.file_packaging.FilePackager method)
,
[1]
(clustrix.file_packaging.PackageInfo method)
,
[1]
(clustrix.filesystem.ClusterFilesystem method)
,
[1]
(clustrix.filesystem.DiskUsage method)
,
[1]
(clustrix.filesystem.FileInfo method)
,
[1]
(clustrix.local_executor.LocalExecutor method)
__repr__() (clustrix.filesystem.DiskUsage method)
,
[1]
(clustrix.filesystem.FileInfo method)
,
[1]
A
add_file_references() (clustrix.dependency_analysis.DependencyGraph method)
,
[1]
add_filesystem_calls() (clustrix.dependency_analysis.DependencyGraph method)
,
[1]
add_imports() (clustrix.dependency_analysis.DependencyGraph method)
,
[1]
add_local_function_calls() (clustrix.dependency_analysis.DependencyGraph method)
,
[1]
aks_cluster_name (clustrix.config.ClusterConfig attribute)
analyze_function() (clustrix.dependency_analysis.DependencyAnalyzer method)
,
[1]
analyze_function_dependencies() (in module clustrix.dependency_analysis)
,
[1]
analyze_function_loops() (in module clustrix.dependency_analysis)
,
[1]
analyze_loops() (clustrix.dependency_analysis.LoopAnalyzer method)
,
[1]
api_key (clustrix.config.ClusterConfig attribute)
async_submit (clustrix.config.ClusterConfig attribute)
auto_gpu_packages (clustrix.config.ClusterConfig attribute)
auto_gpu_parallel (clustrix.config.ClusterConfig attribute)
auto_parallel (clustrix.config.ClusterConfig attribute)
auto_provision_k8s (clustrix.config.ClusterConfig attribute)
aws_access_key (clustrix.config.ClusterConfig attribute)
aws_access_key_id (clustrix.config.ClusterConfig attribute)
aws_cluster_type (clustrix.config.ClusterConfig attribute)
aws_instance_type (clustrix.config.ClusterConfig attribute)
aws_profile (clustrix.config.ClusterConfig attribute)
aws_region (clustrix.config.ClusterConfig attribute)
aws_secret_access_key (clustrix.config.ClusterConfig attribute)
aws_secret_key (clustrix.config.ClusterConfig attribute)
aws_session_token (clustrix.config.ClusterConfig attribute)
AWSCostMonitor (class in clustrix.cost_providers.aws)
azure_client_id (clustrix.config.ClusterConfig attribute)
azure_client_secret (clustrix.config.ClusterConfig attribute)
azure_instance_type (clustrix.config.ClusterConfig attribute)
azure_region (clustrix.config.ClusterConfig attribute)
azure_resource_group (clustrix.config.ClusterConfig attribute)
azure_subscription_id (clustrix.config.ClusterConfig attribute)
azure_tenant_id (clustrix.config.ClusterConfig attribute)
AzureCostMonitor (class in clustrix.cost_providers.azure)
B
BaseCostMonitor (class in clustrix.cost_monitoring)
C
cache_credentials (clustrix.config.ClusterConfig attribute)
choose_executor_type() (in module clustrix.local_executor)
cleanup_on_success (clustrix.config.ClusterConfig attribute)
cloud_auto_configure (clustrix.config.ClusterConfig attribute)
cloud_provider (clustrix.config.ClusterConfig attribute)
cloud_region (clustrix.config.ClusterConfig attribute)
cluster() (in module clustrix.decorator)
cluster_count_files() (in module clustrix)
(in module clustrix.filesystem)
cluster_du() (in module clustrix)
(in module clustrix.filesystem)
cluster_exists() (in module clustrix)
(in module clustrix.filesystem)
cluster_find() (in module clustrix)
(in module clustrix.filesystem)
cluster_glob() (in module clustrix)
(in module clustrix.filesystem)
cluster_host (clustrix.config.ClusterConfig attribute)
cluster_isdir() (in module clustrix)
(in module clustrix.filesystem)
cluster_isfile() (in module clustrix)
(in module clustrix.filesystem)
cluster_ls() (in module clustrix)
(in module clustrix.filesystem)
cluster_packages (clustrix.config.ClusterConfig attribute)
cluster_port (clustrix.config.ClusterConfig attribute)
cluster_stat() (in module clustrix)
(in module clustrix.filesystem)
cluster_type (clustrix.config.ClusterConfig attribute)
ClusterConfig (class in clustrix.config)
ClusterFilesystem (class in clustrix.filesystem)
,
[1]
clusterfy() (clustrix.notebook_magic.ClusterfyMagics method)
ClusterfyMagics (class in clustrix.notebook_magic)
clustrix.config
module
clustrix.decorator
module
clustrix.dependency_analysis
module
clustrix.file_packaging
module
clustrix.filesystem
module
clustrix.local_executor
module
conda_env_name (clustrix.config.ClusterConfig attribute)
configure() (in module clustrix.config)
cost_estimate (clustrix.cost_monitoring.CostReport attribute)
cost_monitoring (clustrix.config.ClusterConfig attribute)
cost_tracking_decorator() (in module clustrix.cost_monitoring)
CostEstimate (class in clustrix.cost_monitoring)
CostReport (class in clustrix.cost_monitoring)
count_files() (clustrix.filesystem.ClusterFilesystem method)
,
[1]
cpu_percent (clustrix.cost_monitoring.ResourceUsage attribute)
create_execution_context() (in module clustrix.file_packaging)
,
[1]
create_local_executor() (in module clustrix.local_executor)
credential_cache_ttl (clustrix.config.ClusterConfig attribute)
cuda_version_preference (clustrix.config.ClusterConfig attribute)
currency (clustrix.cost_monitoring.CostEstimate attribute)
D
DEFAULT_CONFIGS (in module clustrix.notebook_magic)
default_cores (clustrix.config.ClusterConfig attribute)
default_memory (clustrix.config.ClusterConfig attribute)
default_partition (clustrix.config.ClusterConfig attribute)
default_queue (clustrix.config.ClusterConfig attribute)
default_time (clustrix.config.ClusterConfig attribute)
DependencyAnalyzer (class in clustrix.dependency_analysis)
,
[1]
DependencyGraph (class in clustrix.dependency_analysis)
,
[1]
disk_io_mb (clustrix.cost_monitoring.ResourceUsage attribute)
DiskUsage (class in clustrix.filesystem)
,
[1]
du() (clustrix.filesystem.ClusterFilesystem method)
,
[1]
duration_seconds (clustrix.cost_monitoring.CostReport attribute)
E
eks_cluster_name (clustrix.config.ClusterConfig attribute)
environment_variables (clustrix.config.ClusterConfig attribute)
estimate_batch_cost() (clustrix.cost_providers.aws.AWSCostMonitor method)
(clustrix.cost_providers.azure.AzureCostMonitor method)
(clustrix.cost_providers.gcp.GCPCostMonitor method)
estimate_cost() (clustrix.cost_monitoring.BaseCostMonitor method)
(clustrix.cost_providers.aws.AWSCostMonitor method)
(clustrix.cost_providers.azure.AzureCostMonitor method)
(clustrix.cost_providers.gcp.GCPCostMonitor method)
(clustrix.cost_providers.lambda_cloud.LambdaCostMonitor method)
estimate_monthly_cost() (clustrix.cost_providers.lambda_cloud.LambdaCostMonitor method)
estimate_sustained_use_discount() (clustrix.cost_providers.gcp.GCPCostMonitor method)
estimated_cost (clustrix.cost_monitoring.CostEstimate attribute)
execute_loop_parallel() (clustrix.local_executor.LocalExecutor method)
execute_parallel() (clustrix.local_executor.LocalExecutor method)
execute_single() (clustrix.local_executor.LocalExecutor method)
ExecutionContext (class in clustrix.file_packaging)
,
[1]
exists() (clustrix.filesystem.ClusterFilesystem method)
,
[1]
F
FileInfo (class in clustrix.filesystem)
,
[1]
FilePackager (class in clustrix.file_packaging)
,
[1]
FileReference (class in clustrix.dependency_analysis)
,
[1]
FilesystemCall (class in clustrix.dependency_analysis)
,
[1]
find() (clustrix.filesystem.ClusterFilesystem method)
,
[1]
G
gcp_instance_type (clustrix.config.ClusterConfig attribute)
gcp_project_id (clustrix.config.ClusterConfig attribute)
gcp_region (clustrix.config.ClusterConfig attribute)
gcp_service_account_key (clustrix.config.ClusterConfig attribute)
gcp_zone (clustrix.config.ClusterConfig attribute)
GCPCostMonitor (class in clustrix.cost_providers.gcp)
generate_cost_report() (in module clustrix.cost_monitoring)
get_aws_specific_metrics() (clustrix.cost_providers.aws.AWSCostMonitor method)
get_azure_consumption_api_integration() (clustrix.cost_providers.azure.AzureCostMonitor method)
get_azure_specific_metrics() (clustrix.cost_providers.azure.AzureCostMonitor method)
get_billing_api_integration() (clustrix.cost_providers.gcp.GCPCostMonitor method)
get_config() (in module clustrix.config)
get_cost_monitor() (in module clustrix.cost_monitoring)
get_cost_optimization_recommendations() (clustrix.cost_monitoring.BaseCostMonitor method)
(clustrix.cost_providers.aws.AWSCostMonitor method)
(clustrix.cost_providers.azure.AzureCostMonitor method)
(clustrix.cost_providers.gcp.GCPCostMonitor method)
get_cost_optimization_tips() (clustrix.cost_providers.lambda_cloud.LambdaCostMonitor method)
get_cpu_memory_usage() (clustrix.cost_monitoring.BaseCostMonitor method)
get_env_password() (clustrix.config.ClusterConfig method)
get_gcp_specific_metrics() (clustrix.cost_providers.gcp.GCPCostMonitor method)
get_gpu_utilization() (clustrix.cost_monitoring.BaseCostMonitor method)
get_instance_recommendations() (clustrix.cost_providers.lambda_cloud.LambdaCostMonitor method)
get_performance_metrics() (clustrix.cost_providers.lambda_cloud.LambdaCostMonitor method)
get_preemptible_pricing_info() (clustrix.cost_providers.gcp.GCPCostMonitor method)
get_pricing_info() (clustrix.cost_monitoring.BaseCostMonitor method)
(clustrix.cost_providers.aws.AWSCostMonitor method)
(clustrix.cost_providers.azure.AzureCostMonitor method)
(clustrix.cost_providers.gcp.GCPCostMonitor method)
(clustrix.cost_providers.lambda_cloud.LambdaCostMonitor method)
(in module clustrix.cost_monitoring)
get_region_pricing_comparison() (clustrix.cost_providers.aws.AWSCostMonitor method)
(clustrix.cost_providers.azure.AzureCostMonitor method)
(clustrix.cost_providers.gcp.GCPCostMonitor method)
get_resource_usage() (clustrix.cost_monitoring.BaseCostMonitor method)
(clustrix.cost_providers.aws.AWSCostMonitor method)
(clustrix.cost_providers.azure.AzureCostMonitor method)
(clustrix.cost_providers.gcp.GCPCostMonitor method)
(clustrix.cost_providers.lambda_cloud.LambdaCostMonitor method)
get_spot_pricing_info() (clustrix.cost_providers.aws.AWSCostMonitor method)
(clustrix.cost_providers.azure.AzureCostMonitor method)
gke_cluster_name (clustrix.config.ClusterConfig attribute)
glob() (clustrix.filesystem.ClusterFilesystem method)
,
[1]
gpu_detection_enabled (clustrix.config.ClusterConfig attribute)
gpu_memory_fraction (clustrix.config.ClusterConfig attribute)
gpu_requirements (clustrix.config.ClusterConfig attribute)
gpu_stats (clustrix.cost_monitoring.ResourceUsage attribute)
H
hf_hardware (clustrix.config.ClusterConfig attribute)
hf_sdk (clustrix.config.ClusterConfig attribute)
hf_token (clustrix.config.ClusterConfig attribute)
hf_username (clustrix.config.ClusterConfig attribute)
hourly_rate (clustrix.cost_monitoring.CostEstimate attribute)
hours_used (clustrix.cost_monitoring.CostEstimate attribute)
I
ImportInfo (class in clustrix.dependency_analysis)
,
[1]
instance_type (clustrix.cost_monitoring.CostEstimate attribute)
is_file (clustrix.filesystem.FileInfo property)
,
[1]
isdir() (clustrix.filesystem.ClusterFilesystem method)
,
[1]
isfile() (clustrix.filesystem.ClusterFilesystem method)
,
[1]
J
job_poll_interval (clustrix.config.ClusterConfig attribute)
K
k8s_auto_cleanup (clustrix.config.ClusterConfig attribute)
k8s_backoff_limit (clustrix.config.ClusterConfig attribute)
k8s_cluster_name (clustrix.config.ClusterConfig attribute)
k8s_from_scratch (clustrix.config.ClusterConfig attribute)
k8s_image (clustrix.config.ClusterConfig attribute)
k8s_job_ttl_seconds (clustrix.config.ClusterConfig attribute)
k8s_namespace (clustrix.config.ClusterConfig attribute)
k8s_node_count (clustrix.config.ClusterConfig attribute)
k8s_node_type (clustrix.config.ClusterConfig attribute)
k8s_provider (clustrix.config.ClusterConfig attribute)
k8s_pull_policy (clustrix.config.ClusterConfig attribute)
k8s_region (clustrix.config.ClusterConfig attribute)
k8s_remote (clustrix.config.ClusterConfig attribute)
k8s_service_account (clustrix.config.ClusterConfig attribute)
k8s_version (clustrix.config.ClusterConfig attribute)
key_file (clustrix.config.ClusterConfig attribute)
L
lambda_api_key (clustrix.config.ClusterConfig attribute)
lambda_instance_type (clustrix.config.ClusterConfig attribute)
LambdaCostMonitor (class in clustrix.cost_providers.lambda_cloud)
last_updated (clustrix.cost_monitoring.CostEstimate attribute)
load_config() (in module clustrix.config)
load_from_file() (clustrix.config.ClusterConfig class method)
load_ipython_extension() (in module clustrix.notebook_magic)
local_cache_dir (clustrix.config.ClusterConfig attribute)
local_parallel_threshold (clustrix.config.ClusterConfig attribute)
local_work_dir (clustrix.config.ClusterConfig attribute)
LocalExecutor (class in clustrix.local_executor)
LocalFunctionCall (class in clustrix.dependency_analysis)
,
[1]
LoopAnalyzer (class in clustrix.dependency_analysis)
,
[1]
ls() (clustrix.filesystem.ClusterFilesystem method)
,
[1]
M
magics (clustrix.notebook_magic.ClusterfyMagics attribute)
max_gpu_parallel_jobs (clustrix.config.ClusterConfig attribute)
max_parallel_jobs (clustrix.config.ClusterConfig attribute)
memory_percent (clustrix.cost_monitoring.ResourceUsage attribute)
memory_total_mb (clustrix.cost_monitoring.ResourceUsage attribute)
memory_used_mb (clustrix.cost_monitoring.ResourceUsage attribute)
metadata (clustrix.cost_monitoring.CostReport attribute)
modified_datetime (clustrix.filesystem.FileInfo property)
,
[1]
module
clustrix.config
clustrix.decorator
clustrix.dependency_analysis
clustrix.file_packaging
clustrix.filesystem
clustrix.local_executor
module_loads (clustrix.config.ClusterConfig attribute)
N
network_io_mb (clustrix.cost_monitoring.ResourceUsage attribute)
P
package_function() (clustrix.file_packaging.FilePackager method)
,
[1]
package_function_for_execution() (in module clustrix.file_packaging)
,
[1]
package_manager (clustrix.config.ClusterConfig attribute)
PackageInfo (class in clustrix.file_packaging)
,
[1]
password (clustrix.config.ClusterConfig attribute)
password_env_var (clustrix.config.ClusterConfig attribute)
pre_execution_commands (clustrix.config.ClusterConfig attribute)
prefer_gpu_execution (clustrix.config.ClusterConfig attribute)
prefer_local_parallel (clustrix.config.ClusterConfig attribute)
pricing_source (clustrix.cost_monitoring.CostEstimate attribute)
pricing_warning (clustrix.cost_monitoring.CostEstimate attribute)
provider (clustrix.cost_monitoring.CostReport attribute)
python_executable (clustrix.config.ClusterConfig attribute)
R
rapids_ecosystem (clustrix.config.ClusterConfig attribute)
recommendations (clustrix.cost_monitoring.CostReport attribute)
region (clustrix.cost_monitoring.CostReport attribute)
registered (clustrix.notebook_magic.ClusterfyMagics attribute)
remote_work_dir (clustrix.config.ClusterConfig attribute)
resource_usage (clustrix.cost_monitoring.CostReport attribute)
ResourceUsage (class in clustrix.cost_monitoring)
S
save_config() (in module clustrix.config)
save_to_file() (clustrix.config.ClusterConfig method)
ssh_port (clustrix.config.ClusterConfig attribute)
start_cost_monitoring() (in module clustrix.cost_monitoring)
start_monitoring() (clustrix.cost_monitoring.BaseCostMonitor method)
stat() (clustrix.filesystem.ClusterFilesystem method)
,
[1]
stop_monitoring() (clustrix.cost_monitoring.BaseCostMonitor method)
T
timestamp (clustrix.cost_monitoring.CostReport attribute)
total_gb (clustrix.filesystem.DiskUsage property)
,
[1]
total_mb (clustrix.filesystem.DiskUsage property)
,
[1]
U
use_env_password (clustrix.config.ClusterConfig attribute)
use_two_venv (clustrix.config.ClusterConfig attribute)
username (clustrix.config.ClusterConfig attribute)
V
venv_info (clustrix.config.ClusterConfig attribute)
venv_post_install_commands (clustrix.config.ClusterConfig attribute)
venv_setup_timeout (clustrix.config.ClusterConfig attribute)
Clustrix