Skip to content

स्थानीय विकास

विकास और परीक्षण के लिए Potato को स्थानीय रूप से सेट करें।

विकास और परीक्षण के लिए Potato को अपनी स्थानीय मशीन पर चलाएं।

पूर्व-आवश्यकताएं

  • Python 3.7 या उससे अधिक
  • pip पैकेज मैनेजर
  • Git (वैकल्पिक, उदाहरण क्लोन करने के लिए)

इंस्टॉलेशन

pip का उपयोग करके (अनुशंसित)

bash
pip install potato-annotation

सोर्स से

bash
git clone https://github.com/davidjurgens/potato.git
cd potato
pip install -e .

वैकल्पिक डिपेंडेंसी के साथ

bash
# For audio annotation support
pip install potato-annotation[audio]
 
# For all optional features
pip install potato-annotation[all]

त्वरित शुरुआत

1. कॉन्फ़िगरेशन फ़ाइल बनाएं

config.yaml बनाएं:

yaml
task_name: "My First Annotation Task"
 
server:
  port: 8000
 
data_files:
  - path: data.json
    text_field: text
 
annotation_schemes:
  - annotation_type: radio
    name: sentiment
    description: "What is the sentiment?"
    labels:
      - Positive
      - Negative
      - Neutral
 
output:
  path: annotations/

2. सैंपल डेटा तैयार करें

data.json बनाएं:

json
[
  {"id": "1", "text": "I love this product!"},
  {"id": "2", "text": "This is terrible."},
  {"id": "3", "text": "It's okay, nothing special."}
]

3. सर्वर शुरू करें

bash
potato start config.yaml

4. इंटरफ़ेस तक पहुंचें

अपने ब्राउज़र में http://localhost:8000 खोलें

डेवलपमेंट मोड

हॉट रीलोडिंग

कॉन्फ़िग बदलने पर ऑटो-रीस्टार्ट सक्षम करें:

bash
potato start config.yaml --reload

डीबग मोड

विस्तृत लॉगिंग सक्षम करें:

bash
potato start config.yaml --debug

वर्बोज़ आउटपुट

सभी सर्वर गतिविधि देखें:

bash
potato start config.yaml --verbose

डायरेक्टरी संरचना

अनुशंसित प्रोजेक्ट लेआउट:

text
my-annotation-project/
├── config.yaml           # Main configuration
├── data/
│   ├── train.json        # Training data
│   └── main.json         # Annotation data
├── annotations/          # Output directory
├── templates/            # Custom HTML templates
└── static/               # Custom CSS/JS

अपने कॉन्फ़िगरेशन का परीक्षण

कॉन्फ़िग सत्यापित करें

सिंटैक्स त्रुटियों की जांच करें:

bash
potato validate config.yaml

प्रीव्यू मोड

एनोटेशन सहेजे बिना शुरू करें:

bash
potato start config.yaml --preview

सैंपल डेटा के साथ परीक्षण

परीक्षण डेटा जनरेट करें:

bash
potato generate-data --count 10 --output test_data.json

सामान्य समस्याएं

पोर्ट पहले से उपयोग में है

bash
# Use a different port
potato start config.yaml --port 8080
 
# Or in config.yaml
server:
  port: 8080

डेटा फ़ाइल नहीं मिली

सुनिश्चित करें कि पथ कॉन्फ़िग फ़ाइल स्थान के सापेक्ष हैं:

yaml
# If data is in subdirectory
data_files:
  - path: data/main.json
 
# Or use absolute path
data_files:
  - path: /full/path/to/data.json

अनुमति अस्वीकृत

फ़ाइल अनुमतियों की जांच करें:

bash
chmod 755 annotations/
chmod 644 data/*.json

स्थानीय रूप से एकाधिक उपयोगकर्ता

बहु-उपयोगकर्ता परिदृश्यों के परीक्षण के लिए:

yaml
allow_all_users: true
url_user_id_param: user_id

विभिन्न उपयोगकर्ताओं के साथ पहुंचें:

  • http://localhost:8000/?user_id=annotator1
  • http://localhost:8000/?user_id=annotator2

एनोटेशन रीसेट करें

सभी एनोटेशन साफ़ करें और नए सिरे से शुरू करें:

bash
# Remove annotation files
rm -rf annotations/*
 
# Restart server
potato start config.yaml

पर्यावरण चर

पर्यावरण के माध्यम से कॉन्फ़िगर करें:

bash
export POTATO_PORT=8000
export POTATO_DEBUG=true
export POTATO_DATA_PATH=/path/to/data
 
potato start config.yaml

वर्चुअल एनवायरनमेंट के साथ उपयोग

venv

bash
python -m venv potato-env
source potato-env/bin/activate  # Linux/Mac
potato-env\Scripts\activate     # Windows
pip install potato-annotation

Conda

bash
conda create -n potato python=3.10
conda activate potato
pip install potato-annotation

IDE एकीकरण

VS Code

कॉन्फ़िग फ़ाइल समर्थन के लिए YAML एक्सटेंशन इंस्टॉल करें:

json
// settings.json
{
  "yaml.schemas": {
    "https://potato-annotation.com/schema.json": "config.yaml"
  }
}

PyCharm

रन कॉन्फ़िगरेशन सेट करें:

  1. जोड़ें Python
  2. स्क्रिप्ट: potato
  3. पैरामीटर: start config.yaml
  4. वर्किंग डायरेक्टरी: आपका प्रोजेक्ट पथ

अगले कदम

  • Configuration Basics - सभी कॉन्फ़िग विकल्प जानें
  • Data Formats - डेटा संरचना समझें
  • Production Setup - वास्तविक उपयोग के लिए डिप्लॉय करें