Hide navigation sidebar

Hide table of contents sidebar

Skip to content

Toggle site navigation sidebar

vantage6 documentation

Toggle table of contents sidebar

Overview
Introduction
Architecture
Quickstart

1. User guide
Toggle navigation of 1. User guide
2. Node admin guide
Toggle navigation of 2. Node admin guide
3. Server admin guide
Toggle navigation of 3. Server admin guide
4. Algorithm store admin guide
Toggle navigation of 4. Algorithm store admin guide
5. Algorithm Development
Toggle navigation of 5. Algorithm Development
6. Feature descriptions
Toggle navigation of 6. Feature descriptions
- 6.1. Server features
  Toggle navigation of 6.1. Server features
- 6.2. Node features
  Toggle navigation of 6.2. Node features
- 6.3. Algorithm features
  Toggle navigation of 6.3. Algorithm features
  - 6.3.1. Algorithm wrappers
  - 6.3.2. Algorithm container isolation
- 6.4. Communication between components
  Toggle navigation of 6.4. Communication between components
7. Developer community
Toggle navigation of 7. Developer community
8. Function documentation
Toggle navigation of 8. Function documentation
- 8.1. vantage6.cli
  Toggle navigation of 8.1. vantage6.cli
  - 8.1.1. vantage6.cli.cli
  - 8.1.2. vantage6.cli.configuration_manager
    Toggle navigation of 8.1.2. vantage6.cli.configuration_manager
  - 8.1.3. vantage6.cli.configuration_wizard
    Toggle navigation of 8.1.3. vantage6.cli.configuration_wizard
  - 8.1.4. vantage6.cli.context
    Toggle navigation of 8.1.4. vantage6.cli.context
    - vantage6.cli.context.get_context
    - vantage6.cli.context.select_context_class
    - vantage6.cli.context.algorithm_store
      Toggle navigation of vantage6.cli.context.algorithm_store
      - vantage6.cli.context.algorithm_store.AlgorithmStoreContext
    - vantage6.cli.context.base_server
      Toggle navigation of vantage6.cli.context.base_server
      - vantage6.cli.context.base_server.BaseServerContext
    - vantage6.cli.context.node
      Toggle navigation of vantage6.cli.context.node
      - vantage6.cli.context.node.NodeContext
    - vantage6.cli.context.server
      Toggle navigation of vantage6.cli.context.server
      - vantage6.cli.context.server.ServerContext
  - 8.1.5. vantage6.cli.globals
    Toggle navigation of 8.1.5. vantage6.cli.globals
  - 8.1.6. vantage6.cli.rabbitmq
    Toggle navigation of 8.1.6. vantage6.cli.rabbitmq
    - vantage6.cli.rabbitmq.definitions
    - vantage6.cli.rabbitmq.queue_manager
      Toggle navigation of vantage6.cli.rabbitmq.queue_manager
      - vantage6.cli.rabbitmq.queue_manager.RabbitMQManager
  - 8.1.7. vantage6.cli.utils
    Toggle navigation of 8.1.7. vantage6.cli.utils
- 8.2. vantage6.client
  Toggle navigation of 8.2. vantage6.client
  - 8.2.1. vantage6.client.Client
  - 8.2.2. vantage6.client.UserClient
  - 8.2.3. vantage6.client.exceptions
    Toggle navigation of 8.2.3. vantage6.client.exceptions
    - vantage6.client.exceptions.DeserializationException
  - 8.2.4. vantage6.client.filter
    Toggle navigation of 8.2.4. vantage6.client.filter
  - 8.2.5. vantage6.client.subclients
    Toggle navigation of 8.2.5. vantage6.client.subclients
    - vantage6.client.subclients.store
      Toggle navigation of vantage6.client.subclients.store
      - vantage6.client.subclients.store.algorithm
        Toggle navigation of vantage6.client.subclients.store.algorithm
        
        vantage6.client.subclients.store.algorithm.AlgorithmSubClient
      - vantage6.client.subclients.store.algorithm_store
        Toggle navigation of vantage6.client.subclients.store.algorithm_store
        
        vantage6.client.subclients.store.algorithm_store.AlgorithmStoreSubClient
      - vantage6.client.subclients.store.policy
        Toggle navigation of vantage6.client.subclients.store.policy
        
        vantage6.client.subclients.store.policy.PolicySubClient
      - vantage6.client.subclients.store.review
        Toggle navigation of vantage6.client.subclients.store.review
        
        vantage6.client.subclients.store.review.ReviewSubClient
      - vantage6.client.subclients.store.role
        Toggle navigation of vantage6.client.subclients.store.role
        
        vantage6.client.subclients.store.role.StoreRoleSubClient
      - vantage6.client.subclients.store.rule
        Toggle navigation of vantage6.client.subclients.store.rule
        
        vantage6.client.subclients.store.rule.StoreRuleSubClient
      - vantage6.client.subclients.store.user
        Toggle navigation of vantage6.client.subclients.store.user
        
        vantage6.client.subclients.store.user.StoreUserSubClient
    - vantage6.client.subclients.study
      Toggle navigation of vantage6.client.subclients.study
      - vantage6.client.subclients.study.StudySubClient
  - 8.2.6. vantage6.client.utils
    Toggle navigation of 8.2.6. vantage6.client.utils
    - vantage6.client.utils.LogLevel
- 8.3. vantage6.algorithm.client
  Toggle navigation of 8.3. vantage6.algorithm.client
  - 8.3.1. vantage6.algorithm.client.AlgorithmClient
- 8.4. vantage6.algorithm.tools
  Toggle navigation of 8.4. vantage6.algorithm.tools
  - 8.4.1. vantage6.algorithm.tools.decorators
    Toggle navigation of 8.4.1. vantage6.algorithm.tools.decorators
  - 8.4.2. vantage6.algorithm.tools.exceptions
    Toggle navigation of 8.4.2. vantage6.algorithm.tools.exceptions
  - 8.4.3. vantage6.algorithm.tools.mock_client
    Toggle navigation of 8.4.3. vantage6.algorithm.tools.mock_client
    - vantage6.algorithm.tools.mock_client.MockAlgorithmClient
  - 8.4.4. vantage6.algorithm.tools.preprocessing
    Toggle navigation of 8.4.4. vantage6.algorithm.tools.preprocessing
    - vantage6.algorithm.tools.preprocessing.preprocess_data
    - vantage6.algorithm.tools.preprocessing.functions
      Toggle navigation of vantage6.algorithm.tools.preprocessing.functions
      - vantage6.algorithm.tools.preprocessing.functions.dummy_preprocess
      - vantage6.algorithm.tools.preprocessing.functions.filter_range
  - 8.4.5. vantage6.algorithm.tools.util
    Toggle navigation of 8.4.5. vantage6.algorithm.tools.util
  - 8.4.6. vantage6.algorithm.tools.wrap
    Toggle navigation of 8.4.6. vantage6.algorithm.tools.wrap
    - vantage6.algorithm.tools.wrap.load_input
    - vantage6.algorithm.tools.wrap.wrap_algorithm
  - 8.4.7. vantage6.algorithm.tools.wrappers
    Toggle navigation of 8.4.7. vantage6.algorithm.tools.wrappers
- 8.5. vantage6.node
  Toggle navigation of 8.5. vantage6.node
  - 8.5.1. vantage6.node.run
  - 8.5.2. vantage6.node.Node
  - 8.5.3. vantage6.node.VPNConnectMode
  - 8.5.4. vantage6.node.cli
    Toggle navigation of 8.5.4. vantage6.node.cli
    - vantage6.node.cli.node
  - 8.5.5. vantage6.node.context
    Toggle navigation of 8.5.5. vantage6.node.context
  - 8.5.6. vantage6.node.globals
  - 8.5.7. vantage6.node.proxy_server
    Toggle navigation of 8.5.7. vantage6.node.proxy_server
  - 8.5.8. vantage6.node.socket
    Toggle navigation of 8.5.8. vantage6.node.socket
    - vantage6.node.socket.NodeTaskNamespace
  - 8.5.9. vantage6.node.util
    Toggle navigation of 8.5.9. vantage6.node.util
    - vantage6.node.util.get_parent_id
    - vantage6.node.util.colorer
      Toggle navigation of vantage6.node.util.colorer
      - vantage6.node.util.colorer.add_coloring_to_emit_ansi
      - vantage6.node.util.colorer.add_coloring_to_emit_windows
- 8.6. vantage6.backend.common
  Toggle navigation of 8.6. vantage6.backend.common
  - 8.6.1. vantage6.backend.common.get_server_url
  - 8.6.2. vantage6.backend.common.base
    Toggle navigation of 8.6.2. vantage6.backend.common.base
  - 8.6.3. vantage6.backend.common.globals
  - 8.6.4. vantage6.backend.common.jsonable
    Toggle navigation of 8.6.4. vantage6.backend.common.jsonable
    - vantage6.backend.common.jsonable.jsonable
  - 8.6.5. vantage6.backend.common.permission
    Toggle navigation of 8.6.5. vantage6.backend.common.permission
  - 8.6.6. vantage6.backend.common.permission_models
    Toggle navigation of 8.6.6. vantage6.backend.common.permission_models
    - vantage6.backend.common.permission_models.RoleInterface
    - vantage6.backend.common.permission_models.RuleInterface
  - 8.6.7. vantage6.backend.common.resource
    Toggle navigation of 8.6.7. vantage6.backend.common.resource
    - vantage6.backend.common.resource.error_handling
      Toggle navigation of vantage6.backend.common.resource.error_handling
    - vantage6.backend.common.resource.input_schema
      Toggle navigation of vantage6.backend.common.resource.input_schema
    - vantage6.backend.common.resource.pagination
      Toggle navigation of vantage6.backend.common.resource.pagination
      - vantage6.backend.common.resource.pagination.Page
      - vantage6.backend.common.resource.pagination.Pagination
    - vantage6.backend.common.resource.role
      Toggle navigation of vantage6.backend.common.resource.role
  - 8.6.8. vantage6.backend.common.session
  - 8.6.9. vantage6.backend.common.test_context
    Toggle navigation of 8.6.9. vantage6.backend.common.test_context
    - vantage6.backend.common.test_context.TestContext
- 8.7. vantage6.common
  Toggle navigation of 8.7. vantage6.common
  - 8.7.1. vantage6.common.base64s_to_bytes
  - 8.7.2. vantage6.common.bytes_to_base64s
  - 8.7.3. vantage6.common.debug
  - 8.7.4. vantage6.common.echo
  - 8.7.5. vantage6.common.ensure_config_dir_writable
  - 8.7.6. vantage6.common.error
  - 8.7.7. vantage6.common.generate_apikey
  - 8.7.8. vantage6.common.get_config_path
  - 8.7.9. vantage6.common.get_database_config
  - 8.7.10. vantage6.common.info
  - 8.7.11. vantage6.common.is_ip_address
  - 8.7.12. vantage6.common.logger_name
  - 8.7.13. vantage6.common.split_rabbitmq_uri
  - 8.7.14. vantage6.common.warning
  - 8.7.15. vantage6.common.ClickLogger
  - 8.7.16. vantage6.common.Singleton
  - 8.7.17. vantage6.common.WhoAmI
  - 8.7.18. vantage6.common.colors
    Toggle navigation of 8.7.18. vantage6.common.colors
    - vantage6.common.colors.ColorStreamHandler
  - 8.7.19. vantage6.common.configuration_manager
    Toggle navigation of 8.7.19. vantage6.common.configuration_manager
    - vantage6.common.configuration_manager.Configuration
    - vantage6.common.configuration_manager.ConfigurationManager
  - 8.7.20. vantage6.common.context
    Toggle navigation of 8.7.20. vantage6.common.context
    - vantage6.common.context.AppContext
  - 8.7.21. vantage6.common.docker
    Toggle navigation of 8.7.21. vantage6.common.docker
    - vantage6.common.docker.addons
      Toggle navigation of vantage6.common.docker.addons
    - vantage6.common.docker.network_manager
      Toggle navigation of vantage6.common.docker.network_manager
      - vantage6.common.docker.network_manager.remove_subnet_mask
      - vantage6.common.docker.network_manager.NetworkManager
  - 8.7.22. vantage6.common.encryption
    Toggle navigation of 8.7.22. vantage6.common.encryption
  - 8.7.23. vantage6.common.enum
    Toggle navigation of 8.7.23. vantage6.common.enum
    - vantage6.common.enum.AlgorithmViewPolicies
    - vantage6.common.enum.StorePolicies
  - 8.7.24. vantage6.common.exceptions
    Toggle navigation of 8.7.24. vantage6.common.exceptions
    - vantage6.common.exceptions.AuthenticationException
  - 8.7.25. vantage6.common.globals
    Toggle navigation of 8.7.25. vantage6.common.globals
  - 8.7.26. vantage6.common.log
    Toggle navigation of 8.7.26. vantage6.common.log
    - vantage6.common.log.get_file_logger
  - 8.7.27. vantage6.common.serialization
    Toggle navigation of 8.7.27. vantage6.common.serialization
    - vantage6.common.serialization.serialize
  - 8.7.28. vantage6.common.task_status
    Toggle navigation of 8.7.28. vantage6.common.task_status
  - 8.7.29. vantage6.common.utest
    Toggle navigation of 8.7.29. vantage6.common.utest
9. Glossary

Release notes
Partners

Toggle table of contents sidebar

8.7.27. vantage6.common.serialization¶

Functions

serialize(data)

Serialize data using the specified format

vantage6.common.serialization.serialize

vantage6.common.log.get_file_logger

Copyright © 2022 vantage6

Made with Sphinx and @pradyunsg's Furo