CorrDim

User guide

  • Installation
    • Package install
      • Linux GPU (CUDA PyTorch)
    • Install from source
    • Build the docs locally
  • Concepts
    • What CorrDim measures
    • How the pipeline works
    • Backend model
    • API layers
  • Quick start
    • Text to correlation dimension
    • Get the curve first
    • Start from vectors
    • Progressive analysis
      • From progressive curve to many fitted dimensions
    • Which function should I use?
  • Command-line interface
    • Available commands
    • Measure a text file
    • Export the full curve
    • Fit a dimension from saved curve data
    • Common options
  • Examples
    • Running the example script
    • Good starting points
    • API reference

Reference

  • API reference
    • corrdim package
      • CurveResult
        • CurveResult.corrints
        • CurveResult.epsilons
        • CurveResult.sequence_length
      • DimensionResult
        • DimensionResult.corrdim
        • DimensionResult.corrints
        • DimensionResult.corrints_linear_region
        • DimensionResult.epsilons
        • DimensionResult.epsilons_linear_region
        • DimensionResult.fit_r2
        • DimensionResult.linear_region_bounds
        • DimensionResult.sequence_length
      • ProgressiveCurveResult
        • ProgressiveCurveResult.corrints_progressive
        • ProgressiveCurveResult.epsilons
        • ProgressiveCurveResult.sequence_length
      • ProgressiveDimensionResult
        • ProgressiveDimensionResult.by_prefix
        • ProgressiveDimensionResult.corrdims
        • ProgressiveDimensionResult.epsilons
        • ProgressiveDimensionResult.measure_every_tokens
        • ProgressiveDimensionResult.sequence_length
        • ProgressiveDimensionResult.skip_prefix_tokens
      • auto_linear_region_bounds()
      • available_corrint_backends()
      • clamp()
      • clear_model_cache()
      • correlation_counts()
      • correlation_integral()
      • curve_from_text()
      • curve_from_texts()
      • curve_from_vectors()
      • curve_from_vectors_batch()
      • estimate_dimension_from_curve()
      • estimate_dimension_from_curves()
      • get_corrint_backend()
      • measure_text()
      • measure_text_progressive()
      • measure_texts()
      • measure_texts_progressive()
      • progressive_correlation_counts()
      • progressive_correlation_integral()
      • progressive_curve_from_text()
      • progressive_curve_from_texts()
      • progressive_curve_from_vectors()
      • progressive_curve_from_vectors_batch()
      • reduce_dimension()
      • set_corrint_backend()
      • text_to_vectors()
    • high_level module
      • measure_text()
      • measure_text_progressive()
      • measure_texts()
      • measure_texts_progressive()
    • low_level module
      • clear_model_cache()
      • curve_from_text()
      • curve_from_texts()
      • curve_from_vectors()
      • curve_from_vectors_batch()
      • progressive_curve_from_text()
      • progressive_curve_from_texts()
      • progressive_curve_from_vectors()
      • progressive_curve_from_vectors_batch()
      • text_to_vectors()
    • dimension module
      • auto_linear_region_bounds()
      • estimate_dimension_from_curve()
      • estimate_dimension_from_curves()
    • corrint module
      • CorrIntBackend
        • CorrIntBackend.AUTO
        • CorrIntBackend.PYTORCH
        • CorrIntBackend.PYTORCH_FAST
        • CorrIntBackend.TRITON
      • available_corrint_backends()
      • correlation_counts()
      • correlation_integral()
      • get_corrint_backend()
      • progressive_correlation_counts()
      • progressive_correlation_integral()
      • resolve_corrint_backend()
      • set_corrint_backend()
    • models module
      • GPT2Wrapper
      • LLaMAWrapper
      • LanguageModelWrapper
        • LanguageModelWrapper.get_log_probabilities()
      • TransformersModelWrapper
        • TransformersModelWrapper.decode()
        • TransformersModelWrapper.encode()
        • TransformersModelWrapper.get_log_probabilities()
        • TransformersModelWrapper.get_log_probabilities_batch()
      • create_model_wrapper()
    • types module
      • CurveResult
        • CurveResult.corrints
        • CurveResult.epsilons
        • CurveResult.sequence_length
      • DimensionResult
        • DimensionResult.corrdim
        • DimensionResult.corrints
        • DimensionResult.corrints_linear_region
        • DimensionResult.epsilons
        • DimensionResult.epsilons_linear_region
        • DimensionResult.fit_r2
        • DimensionResult.linear_region_bounds
        • DimensionResult.sequence_length
      • ProgressiveCurveResult
        • ProgressiveCurveResult.corrints_progressive
        • ProgressiveCurveResult.epsilons
        • ProgressiveCurveResult.sequence_length
      • ProgressiveDimensionResult
        • ProgressiveDimensionResult.by_prefix
        • ProgressiveDimensionResult.corrdims
        • ProgressiveDimensionResult.epsilons
        • ProgressiveDimensionResult.measure_every_tokens
        • ProgressiveDimensionResult.sequence_length
        • ProgressiveDimensionResult.skip_prefix_tokens
    • utils module
      • clamp()
      • group_add()
      • group_mean()
      • reduce_dimension()
    • cli module
      • main()
CorrDim
  • Search

© Copyright .

Built with Sphinx using a theme provided by Read the Docs.