Skip to main content
EDIT THIS PAGESUBMIT AN ISSUE

Module Basics

In this tutorial, we'll explore how to use the commune library for module management in Python. The commune library provides functionalities for managing and serving code modules easily.

Table of Contents​

Finding Your Module​

You can use the following steps to find and work with modules using the commune library.

New Module Creation​

To create a new module, you can use the commune command line tool:

c new_module agi
c.new_module('agi')
{
    'success': True,
    'path': '/Users/salvivona/commune/agi',
    'module': 'agi',
    'class_name': 'Agi',
    'msg': ' created a new repo called agi'
}
home/saltoshi/commune/modules/agi/agi.py
c serve agi
or
c agi/serve
or
a agi serve

OUTPUT

    'success': True,
    'name': 'agi',
    'address': '0.0.0.0:50129',
    'kwargs': {}
}
c namespace

OUTPUT

c agi filepath

Searching for a Specific Module​

To search for a specific module, you can use the c.modules() function with a search query:

c modules model.openai
c.modules('model.openai')

OUTPUT

['model.openai']

Viewing Module Info​

You can view the information of a specific module using the info() method:

model_openai = c.module('model.openai')
c.print(model_openai.info(*args, **kwargs))

or

c.print(c.call('model.openai/info', *args, **kwargs))

Module Management​

Once you've found your module, you can manage it using the following steps.

Accessing a Module​

You can access a module using the c.module() function:

demo = c.module('demo')
c.print('## Code for demo module')
c.print(demo.code())

Viewing Module Config​

You can view the configuration of a module using the config() method:

demo.config()

OUTPUT

{
    'name': 'demo',
    'version': '0.1.0',
    'description': 'A demo module for testing purposes',
    'author': 'John Doe',
    'email': '
    'license': 'MIT',

}

This is the yaml file if the module has a config file stored in the same directory as the module, otherwise it will be the key word arguments of the init method of the module.

Listing Module Functions​

To list the functions of a module, use the fns() method:

demo.fns()

Searching for a Function​

To search for a specific function within a module, use the fns() method with a search query:

function_search_query = 'bro'
matching_functions = demo.fns(function_search_query)
c.print(matching_functions)

Function Schema​

You can retrieve the schema of a specific function using the schema() method:

c.module('model.openai').schema()
{
    '__init__': {'input': {'a': 'int'}, 'default': {'a': 1}, 'output': {}, 'docs': None, 'type': 'self'},
    'call': {'input': {'b': 'int'}, 'default': {'b': 1}, 'output': {}, 'docs': None, 'type': 'self'}
}

This concludes our tutorial on module management using the commune library. You've learned how to find modules, manage their functions, serve them, and interact with served modules. This library can greatly simplify the process of managing and deploying code modules in your projects.

Feel free to use and adapt this markdown document for your tutorial needs. Make sure to adjust any details as necessary and include code snippets or explanations for each step to ensure clarity and comprehensiveness.