Create SteeringVectorMetadata.json

SteeringVectorMetadata.json

@@ -0,0 +1,157 @@
+{
+  "required": {
+    "id": "string",
+    "name": "string",
+    "model_compatibility": {
+      "model_family": "string",
+      "model_version": "string"
+    },
+    "layer_targets": [
+      {
+        "layer_name": "string",
+        "indices": [int],
+        "layer_type": "string"
+      }
+    ],
+    "steering_vector_type": "string",
+    "vector_dimensions": {
+      "num_vectors": "int",
+      "vector_shape": "[int, int]",
+      "vector_dtype": "string"
+    }
+  },
+  "retired_or_optional": {
+    "model_compatibility": {
+      "model_name": "string (optional)",
+      "architecture_details": {
+        "framework": "string (optional)",
+        "quantization_bits": "int | null (optional)",
+        "quantization_method": "string | null (optional)",
+        "embedding_dim": "int (optional)",
+        "num_attention_heads": "int (optional)",
+        "num_hidden_layers": "int (optional)",
+        "activation_function": "string (optional)",
+        "rope_scaling_type": "string | null (optional)",
+        "torch_dtype_inference": "string (optional)"
+      },
+      "supported_vllm_versions": "[string] (optional)",
+      "supported_lmstudio_versions": "[string] (optional)",
+      "supported_gguf_quants": "[string] (optional)"
+    },
+    "layer_targets": {
+      "sub_layer_component": "string | null (optional)",
+      "target_dimension": "int | null (optional)",
+      "application_mode": "string (optional)"
+    },
+    "vector_dimensions": {
+      "vector_format": "string (optional)"
+    },
+    "application_semantics": {
+      "injection_method": "string (optional)",
+      "scaling_factor_default": "float (optional)",
+      "scaling_factor_range": "[float, float] (optional)",
+      "default_aggregator": "string (optional)",
+      "supported_aggregators": "[string] (optional)",
+      "default_operator": "string (optional)",
+      "supported_operators": "[string] (optional)",
+      "requires_gradient": "boolean (optional)",
+      "context_window_sensitivity": "string | null (optional)"
+    },
+    "data_provenance": {
+      "source_dataset_id": "string (optional)",
+      "source_dataset_version": "string | null (optional)",
+      "data_source_type": "string (optional)",
+      "num_samples": "int (optional)",
+      "data_size_gb": "float (optional)",
+      "preprocessing_pipeline_hash": "string (optional)",
+      "original_data_origin": "string | null (optional)",
+      "external_data_license": "string | null (optional)"
+    },
+    "generation_details": {
+      "method_name": "string (optional)",
+      "framework_version": "string (optional)",
+      "library_dependencies": "[{name: string, version: string}] (optional)",
+      "hyperparameters_used": "{string: any} (optional)",
+      "training_epochs_or_steps": "int | null (optional)",
+      "loss_function": "string | null (optional)",
+      "optimizer": "string | null (optional)",
+      "seed_used": "int | null (optional)",
+      "gpu_hardware_used": "string | null (optional)",
+      "generation_code_commit": "string (optional)"
+    },
+    "tags": "[string] (optional)",
+    "creator": {
+      "user_id": "string (optional)",
+      "username": "string (optional)",
+      "organization": "string | null (optional)",
+      "contact_email": "string | null (optional)",
+      "orcid_id": "string | null (optional)"
+    },
+    "version_control": {
+      "major": "int (optional)",
+      "minor": "int (optional)",
+      "patch": "int (optional)",
+      "prerelease": "string | null (optional)",
+      "build_metadata": "string | null (optional)",
+      "commit_hash": "string (optional)"
+    },
+    "status_lifecycle": {
+      "created_at": "ISO8601 timestamp (optional)",
+      "updated_at": "ISO8601 timestamp (optional)",
+      "last_validated_at": "ISO8601 timestamp | null (optional)",
+      "status": "string (optional)",
+      "status_reason": "string | null (optional)",
+      "replacement_id": "string | null (optional)"
+    },
+    "performance_metrics": {
+      "primary_evaluation_metric": {
+        "metric_name": "string (optional)",
+        "value": "float (optional)",
+        "unit": "string | null (optional)",
+        "comparison_baseline_id": "string | null (optional)",
+        "comparison_value": "float | null (optional)",
+        "statistical_significance_p_value": "float | null (optional)"
+      },
+      "secondary_evaluation_metrics": "[{metric_name: string, value: float, unit: string | null}] (optional)",
+      "evaluation_dataset_id": "string (optional)",
+      "evaluation_framework": "string (optional)",
+      "evaluation_code_commit": "string (optional)",
+      "human_eval_results": "{string: float} | null (optional)"
+    },
+    "resource_requirements": {
+      "inference_cpu_ram_mb_min": "int | null (optional)",
+      "inference_gpu_memory_mb_min": "int | null (optional)",
+      "training_gpu_memory_mb_min": "int | null (optional)",
+      "estimated_latency_ms_per_token_avg": "float | null (optional)",
+      "estimated_latency_ms_per_token_std": "float | null (optional)",
+      "compute_platform_preference": "string | null (optional)"
+    },
+    "safety_compliance_and_ethics": {
+      "license": "string (optional)",
+      "intended_use": "string (optional)",
+      "known_limitations": "string (optional)",
+      "potential_biases": "[string] (optional)",
+      "ethical_considerations": "[string] (optional)",
+      "security_vulnerabilities_reported": "[{date: ISO8601 timestamp, description: string, status: string}] (optional)",
+      "p_ii_data_handling": "boolean (optional)"
+    },
+    "download_options": [
+      {
+        "url": "string (optional)",
+        "checksum_sha256": "string (optional)",
+        "file_size_bytes": "int (optional)",
+        "compression_type": "string | null (optional)",
+        "hosting_provider": "string | null (optional)"
+      }
+    ],
+    "usage_examples": "[{language: string, code_snippet: string, description: string, environment_notes: string | null}] (optional)",
+    "references": "[{title: string, url: string, type: string, citation_text: string | null}] (optional)",
+    "feedback_channel": {
+      "type": "string (optional)",
+      "url": "string | null (optional)",
+      "email": "string | null (optional)",
+      "issue_tracker_url": "string | null (optional)"
+    },
+    "change_log": "[{version: string, date: ISO8601 timestamp, changes: [string], author: string}] (optional)"
+  }
+}