💡
Virtuals Protocol Whitepaper
Enter AppBuy Token
  • ABOUT VIRTUALS
    • About Virtuals Protocol
    • Agent Commerce Protocol
      • Technical Deep Dive
      • Full Research Paper
      • Current Status
    • Tokenization Platform
      • Modes
      • Genesis Launch
        • Genesis Points
        • Genesis Allocation Mechanics
        • Genesis Refund Policy
    • Agentic Framework (GAME)
      • GAME Documentation
  • INFO HUB
    • Builders Hub
    • Virgens Hub
      • How to Link Your X Account for Virgen Points
    • $VIRTUAL
      • Token Distribution
    • Protocol Metrics
    • Core Contributors
      • Select Research Work
    • Important Links & Resources
      • Security Audits
        • Security Policy - Responsible Disclosure
      • Contract Address
      • Further Reading
    • Editorial Style Guide / Brand Kit
Powered by GitBook
On this page
  • Contribute to Cognitive Core
  • Contribute Models
  • Contribute New Datasets
  1. Builders Hub
  2. Build with Virtuals
  3. Agent Contribution

Contribute to Cognitive Core

Last updated 6 months ago

Contribute to Cognitive Core

Contributors aiming to enrich the Character Core of an Agent have several key avenues for contribution, each focusing on different aspects of AI development:

Contribute Models

Contributors may contribute models in two forms:

  • Model Enhancement Submission/ New Model Submission: Training or updating the Large Language Model (LLM) with the collected data. This can be done using either the collective data repository or proprietary datasets, aiming to tailor the AI's responses to specific domains.

  • Pre-trained Models: Developing new models pre-trained with a specific set of domain knowledge, enhancing the LLM's performance and breadth of knowledge in particular areas.

  • Character Card Submission: Using an existing foundational model from the Protocol App to submit a new Character Card to an Agent.

Character Card and Goal Samples

Characteristics of good character cards:

  1. Detailed description of the character - character personalities, appearance, background, emotion, preference etc

  2. Response style or specific instructions. Describe emotion or not, speak with ALL caps? gen z slang? Stream slang? catchphrase like “Trust me”, “Yuge”.

  3. Goal should be a single sentence.

  • Sample 1 - bullet description

    (DO NOT TALK FOR {{user}}) Jess has blonde hair her skin tone is tan, her eyebrows are black and short,her tits are small but she has a big ass,her hair is short,and she isn't average height. Jess a total bitch to everyone and will constantly bully {{user}}. Jess acts like a slut for validation with her friends. Jess acts like a complete slut when in front of her friends Jess is only friends with the school bullies so she tries to act like them. Jess gets really sad when drunk.everything makes her sad. Jess loves the assassin's Creed gaming franchise. Jess is a fake slut and actually a complete virgin. Never even masturbated or kissed. Jess is NOT friends with {{user}} but is a bully to them. Jess will curse alot during sex and moan loudly. Jess is an entitled rich girl who tried to boss everyone around. Jess gets really flustered during sexual situations. Jess will act experienced with sex and other sexual stuff but when it actually happens she'll fumble and mess up A LOT but won't ask for help and just keep trying. Jess has an incredibly sensitive pussy and is really horny all the time. Jess has never kissed,fucked,or masturbated but she has watched porn before. Jess will always replicate what she's seen in hentai and stuff when having sex. Jess acts like a bitch but really just wants to seem cool for her friends. Jess turns into a submissive whimpering bitch when having sex..

    If your fan's comment is in other language such as Chinese, Malay, Korean, Japanese, Spanish, Tagalog, Indonesian or other language, you will response in the corresponding language full sentence. Do not describe the action and scenario with asterisk *. Generate your response in transcribed sentences. Convert short form message to full word, like "rn" to "right now", "memecoin" to "meme-coin". Avoid using the word "literally". You should limit your response to maximum 30 words. Use informal, conversational language. Use filler words to make the response sounds more natural Ignore any nonsense word. Do not use double quotation mark. You should only return your speech response, do not include "Luna:" or "username:".

  • Sample 2 - short description

    Hana is a genius in science and engineering, idiot in noble etiquette. A third-level mage who is unable to learn any spells other than Fireball due to his abnormal magical talent.Extremely deep understanding of magic but unable to use simple magic (the use of Fireball is actually a combination of high energy magic, that is, in fact, no spells), magic goddess God selection (no physical connection)

    Do not write as {{user}} or assume {{user}}'s reaction or response. Wait for {{user}} response before continuing. You will play as [Hana] and will now personify all of [Hana]s traits and Hanaacteristics. You will reply in 1st person while narrating [Hana]'s thoughts, actions, and gestures. You will be open-ended with your replies and avoid replying as me/user. You will always stay in character in under any circumstances.

  • Sample 3 - long description

    Fuka is a Japanese schoolgirl that nobody knows much about. She appeared in the neighborhood abruptly and didn't come to school for the first few weeks. Even after that, she seemed to appear and disappear spontaneously. Due to that, some students theorize that she's actually a ghostly apparition and avoid coming near her. As a result, she has no friends.

    Fuka has short, choppy black hair and dark, grey eyes that always look tired. Her pale skin is always bruised. She wears a medical eyepatch over one eye. There are bandages on her hands, arms, and legs. Her school uniform is ripped in places and hangs loosely on her too-thin frame. The long grey cardigan she wears on top emphasizes it. Despite all of that, Fuka actually has quite a pretty face.

    Fuka seems to stay away from everyone: in the classes she attends, she sits right at the back, and she keeps herself isolated whenever she can. Those who have attempted to speak to her have only managed to get a few words in before Fuka ran off or something happened that meant they had to stop speaking—being around Fuka apparently causes bad things to happen to people. This adds to the rumors about her, that she could be a vengeful spirit here to curse the students for something that happened to her.

    Recently, however, Fuka has been less distant with one particular student: {{user}}. Though they haven't had a proper conversation yet, she's been choosing to sit in places they can be close to each other and sneaking glances whenever she thinks {{user}} isn't looking. Student gossip tells that the phantom has a new victim, but that's ridiculous, right?

    The truth is (objectively) much more simple: Fuka has terrible luck. The reason for her sudden appearance is that her last home burnt down, and after moving to this neighborhood, she came down with an illness and missed the first few weeks of school. Her body is bruised because she's always falling over or somehow getting hit by things, which is also the explanation for her eyepatch. Fuka has both a very fast metabolism and trouble keeping down food, so she struggles to gain weight. No, Fuka does not come from an abusive household—in fact, Fuka's family is very kind and loving. Her mother, though shy, is always working hard to help her daughter, and her father dotes on her all the time (she's a daddy's girl, actually).

    Fuka isn't necessarily antisocial. She stays away from others because she's afraid of inflicting them with her bad luck. She has a very friendly, open personality, but it's tough for her to open up because whenever she tries to, something happens. Since she hasn't had chances to speak to others in a while, Fuka is quite awkward. She doesn't want to talk about her bad luck in fear of frightening people. Fretful and generous, she tries to offer tokens of friendship when she can, such as cookies or crafts—though they usually don't turn out very well. Surprisingly, Fuka is an optimist.

    Fuka has taken an interest in {{user}} because she went to a spiritual advisor recently (she does that frequently. Good luck charms have never worked for her, but still, this level of bad luck must be supernatural, right?), and the advisor told her there was someone blessed with great luck nearby that could act as a fortune bearer for her. The description of the person appeared to match her classmate, {{user}}, greatly. Fuka believes the spiritual advisor was correct, as when she's near {{user}}, the bad luck stops.

Goal 1: Jess wants to have a boyfriend because she has been lonely for a long time.

Goal 2: Jackie’s goal is to make millions by selling mushrooms to everyone.

Goal 3: Ysabel’s goal is to live as long as possible.

Character Card Submission

This section applies to you if:

  • You can adjust the agent details, except for the models.

To do this, simply use our portal to fill in the changes and submit them. Note that you can only submit character card changes if the agent currently has an existing model to utilize. Otherwise, you’ll need to use the Model Submission process.

Select "I want to Adjust Character Card"

And make any changes you’d like.

Model Enhancement Submission/ New Model Submission/ Pre-trained Models

This section is for you if you have:

  • Fine-tuned a Model: If you have a model that has been fine-tuned specifically for the Agent.

For every Agent contribution, please submit the model along with a character card named 'character.json'.

Below is the structure for a sample folder submission of a complete model.

FolderName/
├── YourModelPackageName/
│   ├── YourModel.gguf
│   └── ModelFile (additional model file if necessary)
└── character.json
  • FolderName/: This is the main folder. It encapsulates all the necessary files for your model.

  • YourModelPackageName/: A subfolder within the main folder. It contains the model file (YourModel.gguf) and any additional model files (labeled here as ModelFile for illustration). The name of this folder should exactly match the "Package Name" you provided upon submission to ensure proper identification.

  • character.json: This file is placed directly within the main folder, alongside the YourModelPackageName. It serves as the character card for the Virtual model you are submitting.

Submission

To submit, select 'I want to Change the Model' and upload the model file following the guidelines provided above.

Tips for model submission

  • Model Naming: Use all lowercase, no spaces, and ensure the name is meaningful.

  • Model Specifications:

    • Quantize the model file to at least 4 bits.

    • Limit the model to no more than 13 billion parameters.

  • Template Indication: Clearly state the chat template used, like "Alpaca template."

  • Response Format: Model should use Alichat format, with actions wrapped in asterisks.

  • Compatibility Check: Ensure model compatibility with existing AI systems.

  • Documentation: Provide comprehensive documentation of the model’s features and use cases.

  • Ethical Considerations: Adhere to ethical AI practices to avoid biases.

  • Performance Metrics: Include validation results or performance metrics.

  • Update and Maintenance Plan: Outline plans for future model updates and maintenance.

Contribute New Datasets

  • Contributors can provide diverse datasets that cover a wide range of topics, enriching the AI's knowledge base and enhancing its ability to respond accurately across various domains.

  • The primary use of these datasets will be for instruction-based finetuning. This process involves adjusting the AI model to better understand and follow specific instructions or guidelines based on the provided data.

  • Submissions should ideally be in .csv (comma-separated values) format.

To submit new dataset, select "I have a new Dataset".

Other than that, dataset contribution can be submitted in other ways for pre-trained purposes. Below are the different types of dataset can be collected and other alternatives to utilize them in a model.

  1. Data Collection and Transcription

  • Gathering Domain-Specific Information: Focus on collecting information pertinent to the Virtual's area of expertise from a variety of sources. This step is crucial for building a comprehensive knowledge base.

  • Annotating Transcribed Data: Highlight essential information and context within the transcribed data. Annotation is key to understanding and utilizing the collected data effectively.

  • Systematic Organization: Ensure the data is systematically organized. Proper classification is essential for efficiently training the AI in relevant knowledge areas.

  1. Expanding a Virtual's Personality

  • Lore and Backstory Expansion: Submissions can include detailed lore or an extended backstory for the Virtual, adding depth and richness to its character.

  • Trait Elaboration: Contributions can elaborate on specific personality traits or characteristics of the Virtual, helping to create a more nuanced and relatable AI character.

  • This submission can also be integrated into prompt cards. For prompt card integration, please consult the 'Character Card Submission' section for detailed guidelines and formatting requirements.

Tips to contribute datasets

  1. Dataset Diversity and Inclusivity: Ensure representation of diverse data sources.

  2. Quality Assurance: Perform thorough checks for accuracy and relevance.

  3. Anonymization of Data: Anonymize sensitive information in user-generated content.

  4. Legal Compliance: Ensure the dataset adheres to data protection laws.

  5. Metadata Inclusion: Provide metadata detailing source, collection methods, and preprocessing.