Source code for sdp.processors.toloka.create_project

# Copyright (c) 2024, NVIDIA CORPORATION.  All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import json
import os

from sdp.logging import logger
from sdp.processors.base_processor import BaseParallelProcessor, DataEntry

try:
    import toloka.client
    import toloka.client.project.template_builder
    TOLOKA_AVAILABLE = True
except ImportError:
    TOLOKA_AVAILABLE = False
    toloka = None
    




class CreateTolokaProject(BaseParallelProcessor):
    """Creates a Toloka project based on user-provided configurations.

    This class connects to Toloka, configures a new project with a name, description, and instructions,
    and saves the created project details for future use.

    Args:
        project_name (str): The name of the project to be created.
        project_description (str): A description shown to Toloka workers about the project.
        project_instructions (str): Instructions provided to workers on how to complete assigned tasks.
        **kwargs: Additional keyword arguments to be passed to the base class `BaseParallelProcessor`.

    Returns:
        A project created on the Toloka platform, configured and ready for task and pool setup.
    """
    
    def __init__(
        self,
        project_name: str,
        project_description: str,
        project_instructions: str,
        **kwargs,
    ):
        super().__init__(**kwargs)
        self.API_KEY = os.getenv('TOLOKA_API_KEY')
        if not self.API_KEY:
            raise ValueError("TOLOKA_API_KEY environment variable is not set")
            
        self.platform = os.getenv('TOLOKA_PLATFORM')
        if not self.platform:
            raise ValueError("TOLOKA_PLATFORM environment variable is not set")
            
        self.project_name = project_name
        self.project_description = project_description
        self.project_instructions = project_instructions
        self.toloka_availabe = TOLOKA_AVAILABLE

    def process(self):
        """
        Processes the creation of a Toloka project.

        This method establishes a connection to the Toloka API using the API key and platform from environment variables,
        then creates a new project with the specified name, description, and instructions. It also defines
        the task specifications including the input and output fields, and then submits the project to Toloka.

        After creating the project, it saves the project details (including the project ID) to a specified file.
        """
        logger.info("Processing Toloka project creation...")
        if self.toloka_availabe != True:
            logger.warning("Toloka is currently not supported. CreateTolokaProject processor functionality will be limited.")

        toloka_client = toloka.client.TolokaClient(self.API_KEY, self.platform)

        # Create a new project
        new_project = toloka.client.Project(
            public_name=self.project_name,
            public_description=self.project_description,
            public_instructions=self.project_instructions,
        )

        # Setup the project interface
        text_view = toloka.client.project.template_builder.TextViewV1(
            toloka.client.project.template_builder.InputData('text')
        )
        audio_field = toloka.client.project.template_builder.AudioFieldV1(
            toloka.client.project.template_builder.OutputData('audio_file'),
            validation=toloka.client.project.template_builder.RequiredConditionV1(),
        )
        width_plugin = toloka.client.project.template_builder.TolokaPluginV1('scroll', task_width=500)

        project_interface = toloka.client.project.TemplateBuilderViewSpec(
            view=toloka.client.project.template_builder.ListViewV1(items=[text_view, audio_field]),
            plugins=[width_plugin],
        )

        # Define task specification
        input_specification = {'text': toloka.client.project.StringSpec()}
        output_specification = {'audio_file': toloka.client.project.FileSpec()}

        new_project.task_spec = toloka.client.project.task_spec.TaskSpec(
            input_spec=input_specification,
            output_spec=output_specification,
            view_spec=project_interface,
        )

        # Create the project in Toloka
        created_project = toloka_client.create_project(new_project)

        # Always save project details to a file
        data_file = self.output_manifest_file
        directory = os.path.dirname(data_file)
        if not os.path.exists(directory):
            os.makedirs(directory)

        data = {"project_id": created_project.id, "platform": self.platform}

        with open(data_file, "w") as fout:
            fout.write(json.dumps(data) + "\n")

        logger.info("Project created successfully: Project ID - {}".format(created_project.id))